Shares weergeven

Artikel
07/19/2023

De List Shares bewerking retourneert een lijst met de shares en momentopnamen van de share onder het opgegeven account. Deze API wordt volledig ondersteund, maar het is een verouderde beheer-API. Gebruik in plaats daarvan Bestandsshares - Lijst, geleverd door de opslagresourceprovider (Microsoft.Storage). Zie Bewerkingen op FileShares voor meer informatie over het programmatisch communiceren met FileShare resources met behulp van de opslagresourceprovider.

Protocol beschikbaarheid

Bestandsshareprotocol ingeschakeld	Beschikbaar
SMB
NFS

Aanvraag

U kunt de List Shares aanvraag als volgt samenstellen. HTTPS wordt aanbevolen.

Methode	Aanvraag-URI	HTTP-versie
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

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

Padonderdeel	Beschrijving
`myaccount`	De naam van uw opslagaccount.

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 aanvraag-URI.

Parameter	Beschrijving
`prefix`	Optioneel. Filtert de resultaten om alleen shares te retourneren met namen die beginnen met het opgegeven voorvoegsel.
`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 shares op dat moet worden geretourneerd. Als de aanvraag niet opgeeft `maxresults`of een waarde opgeeft die groter is dan 5000, retourneert de server maximaal 5000 items. Als de parameter is ingesteld op een waarde kleiner dan of gelijk aan nul, retourneert de server statuscode 400 (Ongeldige aanvraag).
`include=metadata,snapshots,deleted`	Optioneel. Hiermee geeft u een of meer gegevenssets op die moeten worden opgenomen in het antwoord: - `snapshots`: Versie 2017-04-17 en hoger. Hiermee geeft u op dat momentopnamen van shares moeten worden opgenomen in het antwoord. Momentopnamen van shares worden weergegeven van oud naar nieuw in het antwoord. - `metadata`: hiermee geeft u op dat metagegevens van de share moeten worden geretourneerd in het antwoord. - `deleted`: geeft aan dat verwijderde bestandsshares moeten worden opgenomen in het antwoord. 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). Alle metagegevensnamen moeten voldoen aan de naamconventies voor C#-id's.
`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. 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.

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 bevat ook aanvullende, standaard HTTP-headers. Alle standaardheaders voldoen aan de HTTP/1.1-protocolspecificatie.

Antwoordheader	Beschrijving
`Content-Type`	Standaard HTTP/1.1-header. 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 de hoofdtekst van het antwoord is als volgt.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults AccountName="https://myaccount.file.core.windows.net">  
  <Prefix>string-value</Prefix>  
  <Marker>string-value</Marker>  
  <MaxResults>int-value</MaxResults>  
  <Shares>  
    <Share>  
      <Name>share-name</Name>  
      <Snapshot>Date-Time Value</Snapshot>
      <Version>01D2AC0C18EDFE36</Version> 
      <Deleted>true</Deleted>  
      <Properties>  
        <Last-Modified>date/time-value</Last-Modified>  
        <Etag>etag</Etag>  
        <Quota>max-share-size</Quota>
        <DeletedTime>Mon, 24 Aug 2020 04:56:10 GMT</DeletedTime>  
        <RemainingRetentionDays>360</RemainingRetentionDays>
        <AccessTier>TransactionOptimized</AccessTier>
        <AccessTierChangeTime>Mon, 24 Aug 2020 03:56:10 GMT</AccessTierChangeTime>
        <AccessTierTransitionState>pending-from-cool</AccessTierTransitionState>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Share>  
  </Shares>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

Het EnabledProtocols element wordt alleen weergegeven in de antwoordtekst in versie 2020-02-10 en hoger.
Het RootSquash element wordt alleen weergegeven in de antwoordtekst in versie 2020-02-10 en hoger, wanneer de ingeschakelde protocollen NFS bevatten.
Het Quota element wordt alleen weergegeven in de antwoordtekst in versie 2015-02-21 en hoger.
De Versionelementen , Deleted, DeletedTimeen RemainingRetentionDays worden alleen weergegeven in de antwoordtekst in versie 2019-12-12 en hoger.
De Prefixelementen , Markeren MaxResults zijn alleen aanwezig als u deze opgeeft in de URI. Het NextMarker element heeft alleen een waarde als de lijstresultaten niet volledig zijn.
Het Metadata element is alleen aanwezig als u de include=metadata parameter opgeeft in de URI. Binnen het Metadata element wordt de waarde van elk naam-waardepaar weergegeven in een element dat overeenkomt met de naam van het paar.
De momentopnamen worden alleen opgenomen in het antwoord als u deinclude=snapshots parameter met de include parameter opgeeft in de aanvraag-URI.
Het AccessTier -element bevat de laag van de share. Als de laag van de share niet is gewijzigd, is deze eigenschap de standaardlaag TransactionOptimized voor opslagaccounts voor algemeen gebruik versie 2 (GPv2). Op Azure Files opslagaccounts is Premiumde eigenschap . Dit is de enige laag die wordt ondersteund.
Het AccessTierChangeTime element is alleen aanwezig als u de toegangslaag voor de share expliciet instelt.
Het AccessTierTransitionState element is alleen aanwezig als de share van de ene laag naar de andere wordt overgezet. Het geeft de laag aan van waaruit de overgang wordt gemaakt.
Het ProvisionedIngressMBps element is alleen aanwezig voor Premium Azure Files accounts en versie 2019-07-07 of hoger. Het toont ingerichte toegangsbeheerobjecten in MiB/s.
Het ProvisionedEgressMBps element is alleen aanwezig voor Premium Azure Files accounts en versie 2019-07-07 of hoger. Het toont het ingerichte uitgaand verkeer in MiB/s.
Het ProvisionedBandwidthMiBps element is alleen aanwezig voor Premium Azure Files accounts en versie 2021-02-12 of hoger. Het toont de ingerichte bandbreedte (inkomend en uitgaand verkeer gecombineerd) in MiB/s.

Voorbeeldantwoord

Zie de sectie Voorbeeldaanvraag en antwoord verderop in dit onderwerp.

Autorisatie

Alleen de accounteigenaar kan deze bewerking aanroepen.

Opmerkingen

Als u een waarde voor de maxresults parameter opgeeft en het aantal shares dat moet worden geretourneerd deze waarde overschrijdt, of de standaardwaarde voor maxresultsoverschrijdt, bevat de hoofdtekst van het antwoord een NextMarker -element. Dit element geeft de volgende share aan die moet worden geretourneerd bij een volgende aanvraag. Als u de volgende set items wilt retourneren, geeft u de waarde van NextMarker op als de markeringsparameter op de URI voor de volgende aanvraag.

Houd er rekening mee dat de waarde van NextMarker moet worden behandeld als ondoorzichtig.

Shares worden in alfabetische volgorde weergegeven in de hoofdtekst van het antwoord.

De List Shares bewerking treedt na 30 seconden op.

Voorbeeld van aanvraag en antwoord

Met de volgende voorbeeld-URI wordt de lijst met shares voor een account aangevraagd. Hiermee worden de maximaal te retourneren resultaten voor de eerste bewerking ingesteld op drie.

GET https://myaccount.file.core.windows.net/?comp=list&maxresults=3&include=snapshots HTTP/1.1

De aanvraag wordt verzonden met deze headers:

x-ms-version: 2020-02-10  
x-ms-date: <date>  
Authorization: SharedKey myaccount:CY1OP3O3jGFpYFbTCBimLn0Xov0vt0khH/D5Gy0fXvg=

De statuscode en antwoordheaders worden als volgt geretourneerd:

HTTP/1.1 200 OK  
Transfer-Encoding: chunked  
Content-Type: application/xml  
Date: <date>  
x-ms-version: 2020-02-10  
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0

De antwoord-XML voor deze aanvraag is als volgt. Houd er rekening mee dat het NextMarker element de set shares volgt en de naam bevat van de volgende share die moet worden geretourneerd.

<?xml version="1.0" encoding="utf-8"?>  
<EnumerationResults ServiceEndpoint=" https://myaccount.file.core.windows.net">  
  <MaxResults>3</MaxResults>  
  <Shares>  
    <Share>  
      <Name>audio</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C6B1B2</Etag>  
        <Quota>55</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>  
      <Name>images</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7C1EEEC</Etag>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>SMB</EnabledProtocols>
      </Properties>  
    </Share>  
    <Share>
      <Name>textfiles</Name>
      <Snapshot>2017-05-12T20:52:22.0000000Z</Snapshot>
      <Properties>
        <Last-Modified><date></Last-Modified>
        <Etag>0x8D3F2E1A9D14700</Etag>
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>RootSquash</RootSquash>
      </Properties>
    </Share>
    <Share>  
      <Name>textfiles</Name>  
      <Properties>  
        <Last-Modified><date></Last-Modified>  
        <Etag>0x8CACB9BD7BACAC3</Etag>  
        <Quota>30</Quota>
        <AccessTier>Premium</AccessTier>
        <EnabledProtocols>NFS</EnabledProtocols>
        <RootSquash>AllSquash</RootSquash>  
      </Properties>  
    </Share>
  </Shares>  
  <NextMarker>video</NextMarker>  
</EnumerationResults>

De volgende lijstbewerking geeft de markering op de aanvraag-URI op, als volgt. De volgende set resultaten wordt geretourneerd, te beginnen met de share die is opgegeven door de markering.

https://myaccount.file.core.windows.net/?comp=list&maxresults=3&marker=video

Zie ook

Azure Files REST API

Share via