Lijstshares

Artikel
08/07/2024

De List Shares bewerking retourneert een lijst met de shares en momentopnamen van shares onder het opgegeven account. Deze API wordt volledig ondersteund, maar het is een verouderde beheer-API. Gebruik in plaats daarvan bestandsshares - lijst met, geleverd door de opslagresourceprovider (Microsoft.Storage). Zie Operations on FileSharesvoor meer informatie over programmatisch werken met FileShare resources met behulp van de opslagresourceprovider.

Beschikbaarheid van protocol

Protocol voor bestandsshare ingeschakeld	Beschikbaar
SMB
NFS

Verzoek

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 in de aanvraag-URI als volgt door uw eigen padonderdelen:

Padonderdeel	Beschrijving
`myaccount`	De naam van uw opslagaccount.

Zie Naamgeving en verwijzingen naar shares, mappen, bestanden en metagegevensvoor meer informatie over padnaamgevingsbeperkingen.

URI-parameters

U kunt de volgende aanvullende parameters opgeven voor de aanvraag-URI.

Parameter	Beschrijving
`prefix`	Facultatief. Hiermee filtert u de resultaten om alleen shares te retourneren met namen die beginnen met het opgegeven voorvoegsel.
`marker`	Facultatief. Een tekenreekswaarde die het deel van de lijst aangeeft dat moet worden geretourneerd met de volgende lijstbewerking. De bewerking retourneert een markeringswaarde in de hoofdtekst van het antwoord als de geretourneerde lijst niet is voltooid. Vervolgens kunt u de markeringswaarde in een volgende aanroep gebruiken om de volgende set lijstitems aan te vragen. De markeringswaarde is ondoorzichtig voor de client.
`maxresults`	Facultatief. Hiermee geeft u het maximum aantal shares dat moet worden geretourneerd. Als de aanvraag geen `maxresults`opgeeft of een waarde groter dan 5.000 opgeeft, retourneert de server maximaal 5000 items. Als de parameter is ingesteld op een waarde die kleiner is dan of gelijk is aan nul, retourneert de server statuscode 400 (Ongeldige aanvraag).
`include=metadata,snapshots,deleted`	Facultatief. 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`: hiermee geeft u op 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 door URL gecodeerde komma ("%82"). Alle namen van metagegevens moeten voldoen aan de naamconventies voor C#-id's.
`timeout`	Facultatief. De parameter `timeout` wordt uitgedrukt in seconden. Zie Time-outs instellen voor Azure Files-bewerkingenvoor meer informatie.

Aanvraagheaders

In de volgende tabel worden de vereiste en optionele aanvraagheaders beschreven.

Aanvraagheader	Beschrijving
`Authorization`	Vereist. Hiermee geeft u het autorisatieschema, de accountnaam en de handtekening op. Zie Aanvragen autoriseren voor Azure Storagevoor meer informatie.
`Date` of `x-ms-date`	Vereist. Hiermee geeft u de Coordinated Universal Time (UTC) voor de aanvraag. Zie Aanvragen autoriseren voor Azure Storagevoor meer informatie.
`x-ms-version`	Vereist voor alle geautoriseerde aanvragen. Hiermee geeft u de versie van de bewerking die moet worden gebruikt voor deze aanvraag. Zie Versiebeheer voor de Azure Storage-servicesvoor meer informatie.
`x-ms-client-request-id`	Facultatief. Biedt een door de client gegenereerde, ondoorzichtige waarde met een tekenlimiet 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 Monitor Azure Filesvoor 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 foutcodesvoor 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. Deze waarde is momenteel `application/xml`.
`x-ms-request-id`	Deze header identificeert de aanvraag die is gemaakt en kan worden gebruikt voor het oplossen van problemen met de aanvraag. Zie Problemen met API-bewerkingen oplossenvoor meer informatie.
`x-ms-version`	Geeft de versie van Azure Files aan die wordt 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 antwoord

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>
        <PaidBurstingEnabled>true</PaidBurstingEnabled>
        <PaidBurstingMaxIops>20000</PaidBurstingMaxIops>
        <PaidBurstingMaxBandwidthMibps>4000</PaidBurstingMaxBandwidthMibps>
      </Properties>  
      <Metadata>  
        <metadata-name>value</metadata-name>  
      </Metadata>  
    </Share>  
  </Shares>  
  <NextMarker>marker-value</NextMarker>  
</EnumerationResults>

Het element EnabledProtocols wordt alleen weergegeven in de hoofdtekst van het antwoord in versie 2020-02-10 en hoger.
Het element RootSquash wordt alleen weergegeven in de hoofdtekst van het antwoord in versie 2020-02-10 en hoger wanneer de ingeschakelde protocollen NFS bevatten. Dit element wordt alleen geretourneerd voor shares, niet voor momentopnamen.
Het element Quota wordt alleen weergegeven in de hoofdtekst van het antwoord in versie 2015-02-21 en hoger.
De elementen Version, Deleted, DeletedTimeen RemainingRetentionDays worden alleen weergegeven in de hoofdtekst van het antwoord in versie 2019-12-12 en hoger.
De Prefix, Markeren MaxResults elementen zijn alleen aanwezig als u deze opgeeft op de URI. Het element NextMarker heeft alleen een waarde als de lijstresultaten niet zijn voltooid.
Het Metadata element is alleen aanwezig als u de parameter include=metadata op de URI opgeeft. Binnen het Metadata element wordt de waarde van elk paar naam-waarde weergegeven in een element dat overeenkomt met de naam van het paar.
De momentopnamen worden alleen opgenomen in het antwoord als u de parameterinclude=snapshots met de parameter include op de aanvraag-URI opgeeft.
Het element AccessTier bevat de laag van de share. Als de laag van de share niet is gewijzigd, is deze eigenschap de standaardlaag TransactionOptimized voor GPv2-opslagaccounts (algemeen gebruik versie 2). In Azure Files-opslagaccounts wordt de eigenschap Premium. Dit is de enige laag die wordt ondersteund.
Het AccessTierChangeTime element is alleen aanwezig als u expliciet de toegangslaag voor de share instelt.
Het AccessTierTransitionState element is alleen aanwezig als de share van de ene laag naar de andere overgaat. Hiermee wordt aangegeven van welke laag deze overgaat.
Het element ProvisionedIngressMBps is alleen aanwezig voor Premium Azure Files-accounts en versie 2019-07-07 of hoger. Het toont ingerichte toegangsbeheerobjecten in MiB/s.
Het element ProvisionedEgressMBps is alleen aanwezig voor Premium Azure Files-accounts en versie 2019-07-07 of hoger. Het toont ingerichte uitgaande verbindingen in MiB/s.
Het element ProvisionedBandwidthMiBps is alleen aanwezig voor Premium Azure Files-accounts en versie 2021-02-12 of hoger. Het toont de ingerichte bandbreedte (gecombineerd inkomend en uitgaand verkeer) in MiB/s.
Het element EnableSnapshotVirtualDirectoryAccess wordt alleen weergegeven in de hoofdtekst van het antwoord in versie 2024-08-04 en hoger, wanneer de ingeschakelde protocollen NFS bevatten. Dit element wordt alleen geretourneerd voor shares, niet voor momentopnamen.
Het element PaidBurstingEnabled is alleen aanwezig voor Premium Azure Files-accounts, in versie 2024-11-04 of hoger. Dit element wordt alleen geretourneerd voor shares, niet voor momentopnamen.
Het element PaidBurstingMaxIops is alleen aanwezig voor Premium Azure Files-accounts, in versie 2024-11-04 of hoger. Deze wordt alleen geretourneerd als PaidBurstingEnabled waar is voor de share. Dit element wordt alleen geretourneerd voor shares, niet voor momentopnamen.
Het element PaidBurstingMaxBandwidthMibps is alleen aanwezig voor Premium Azure Files-accounts, in versie 2024-11-04 of hoger. Deze wordt alleen geretourneerd als PaidBurstingEnabled waar is voor de share. Dit element wordt alleen geretourneerd voor shares, niet voor momentopnamen.

Voorbeeldantwoord

Zie de sectie Voorbeeldaanvraag en -antwoord verderop in dit onderwerp.

Machtiging

Alleen de accounteigenaar kan deze bewerking aanroepen.

Opmerkingen

Als u een waarde opgeeft voor de parameter maxresults 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 aan dat de volgende share moet worden geretourneerd op 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.

Er treedt een time-out op voor de List Shares bewerking na 30 seconden.

Voorbeeldaanvraag en -antwoord

De volgende voorbeeld-URI vraagt de lijst met shares voor een account aan. Hiermee worden de maximumresultaten ingesteld die moeten worden geretourneerd voor de eerste bewerking 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. Het element NextMarker volgt de set shares en bevat de naam 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>
      </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>

Met de volgende lijstbewerking wordt de markering voor de aanvraag-URI als volgt opgegeven. 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

REST API van Azure Files

Delen via