Listresurser

Artikel
08/07/2024

Åtgärden List Shares returnerar en lista över resurser och resursögonblicksbilder under det angivna kontot. Det här API:et stöds fullt ut, men det är ett äldre hanterings-API. Använd filresurser – Lista, som tillhandahålls av lagringsresursprovidern (Microsoft.Storage) i stället. Mer information om hur du interagerar programmatiskt med FileShare resurser med hjälp av lagringsresursprovidern finns i Åtgärder på FileShares.

Protokolltillgänglighet

Aktiverat filresursprotokoll	Tillgänglig
SMB
NFS

Begäran

Du kan skapa List Shares begäran enligt följande. HTTPS rekommenderas.

Metod	Begärande-URI	HTTP-version
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

Ersätt sökvägskomponenterna som visas i begärande-URI:n med dina egna enligt följande:

Sökvägskomponent	Beskrivning
`myaccount`	Namnet på ditt lagringskonto.

Mer information om namngivningsbegränsningar för sökvägar finns i Namngivnings- och referensresurser, kataloger, filer och metadata.

URI-parametrar

Du kan ange följande ytterligare parametrar på begärande-URI:n.

Parameter	Beskrivning
`prefix`	Valfri. Filtrerar resultatet så att endast resurser som har namn som börjar med det angivna prefixet returneras.
`marker`	Valfri. Ett strängvärde som identifierar den del av listan som ska returneras med nästa liståtgärd. Åtgärden returnerar ett markörvärde i svarstexten om listan som returnerades inte slutfördes. Du kan sedan använda markörvärdet i ett efterföljande anrop för att begära nästa uppsättning listobjekt. Markörvärdet är ogenomskinlig för klienten.
`maxresults`	Valfri. Anger det maximala antalet resurser som ska returneras. Om begäran inte anger `maxresults`, eller anger ett värde som är större än 5 000, returnerar servern upp till 5 000 objekt. Om parametern är inställd på ett värde som är mindre än eller lika med noll returnerar servern statuskoden 400 (felaktig begäran).
`include=metadata,snapshots,deleted`	Valfri. Anger en eller flera datauppsättningar som ska ingå i svaret: - `snapshots`: Version 2017-04-17 och senare. Anger att resursögonblicksbilder ska ingå i svaret. Resursögonblicksbilder visas från äldsta till nyaste i svaret. - `metadata`: Anger att resursmetadata ska returneras i svaret. - `deleted`: Anger att borttagna filresurser ska ingå i svaret. Om du vill ange fler än ett av dessa alternativ på URI:n måste du avgränsa varje alternativ med ett URL-kodat kommatecken ("%82"). Alla metadatanamn måste följa namngivningskonventionerna för C#-identifierare.
`timeout`	Valfri. Parametern `timeout` uttrycks i sekunder. Mer information finns i Ange tidsgränser för Azure Files-åtgärder.

Begärandehuvuden

I följande tabell beskrivs obligatoriska och valfria begärandehuvuden.

Begärandehuvud	Beskrivning
`Authorization`	Krävs. Anger auktoriseringsschema, kontonamn och signatur. Mer information finns i Auktorisera begäranden till Azure Storage.
`Date` eller `x-ms-date`	Krävs. Anger UTC (Coordinated Universal Time) för begäran. Mer information finns i Auktorisera begäranden till Azure Storage.
`x-ms-version`	Krävs för alla auktoriserade begäranden. Anger vilken version av åtgärden som ska användas för den här begäran. Mer information finns i Versionshantering för Azure Storage-tjänsterna.
`x-ms-client-request-id`	Valfri. Tillhandahåller ett klientgenererat, täckande värde med en kibibytesteckengräns (KiB) som registreras i loggarna när loggningen konfigureras. Vi rekommenderar starkt att du använder det här huvudet för att korrelera aktiviteter på klientsidan med begäranden som servern tar emot. Mer information finns i Övervaka Azure Files-.

Begärandetext

Ingen.

Svar

Svaret innehåller en HTTP-statuskod, en uppsättning svarshuvuden och en svarstext i XML-format.

Statuskod

En lyckad åtgärd returnerar statuskod 200 (OK). Information om statuskoder finns i Status och felkoder.

Svarshuvuden

Svaret för den här åtgärden innehåller följande rubriker. Svaret innehåller även ytterligare standard-HTTP-huvuden. Alla standardhuvuden överensstämmer med HTTP/1.1-protokollspecifikationen.

Svarsrubrik	Beskrivning
`Content-Type`	Standard-HTTP/1.1-rubrik. Anger i vilket format resultatet returneras. För närvarande är det här värdet `application/xml`.
`x-ms-request-id`	Det här huvudet identifierar unikt den begäran som gjordes och kan användas för att felsöka begäran. Mer information finns i Felsökning av API-åtgärder.
`x-ms-version`	Anger vilken version av Azure Files som används för att köra begäran.
`Date` eller `x-ms-date`	Ett UTC-datum/tid-värde som anger den tid då svaret initierades. Tjänsten genererar det här värdet.
`x-ms-client-request-id`	Du kan använda den här rubriken för att felsöka begäranden och motsvarande svar. Värdet för det här huvudet är lika med värdet för `x-ms-client-request-id`-huvudet, om det finns i begäran. Värdet är högst 1 024 synliga ASCII-tecken. Om `x-ms-client-request-id`-huvudet inte finns i begäran visas inte det här huvudet i svaret.

Svarstext

Formatet för svarstexten är följande.

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

Elementet EnabledProtocols visas endast i svarstexten i version 2020-02-10 och senare.
Elementet RootSquash visas endast i svarstexten i version 2020-02-10 och senare, när de aktiverade protokollen innehåller NFS. Det här elementet returneras endast för resurser, inte för ögonblicksbilder.
Elementet Quota visas endast i svarstexten i version 2015-02-21 och senare.
Elementen Version, Deleted, DeletedTimeoch RemainingRetentionDays visas endast i svarstexten i version 2019-12-12 och senare.
Elementen Prefix, Markeroch MaxResults finns bara om du anger dem på URI:n. Elementet NextMarker har bara ett värde om listresultatet inte är slutfört.
Elementet Metadata finns bara om du anger parametern include=metadata på URI:n. I elementet Metadata visas värdet för varje namn/värde-par i ett element som motsvarar parets namn.
Ögonblicksbilderna ingår endast i svaret om du anger parameterninclude=snapshots med parametern include på begärande-URI:n.
Elementet AccessTier innehåller resursnivån. Om resursens nivå inte har ändrats är den här egenskapen standardnivån TransactionOptimized på GPv2-lagringskonton (generell användning version 2). På Azure Files-lagringskonton är egenskapen Premium, som är den enda nivå som stöds.
Elementet AccessTierChangeTime finns bara om du uttryckligen anger åtkomstnivån för resursen.
Elementet AccessTierTransitionState finns bara om resursen övergår från en nivå till en annan. Den anger vilken nivå den övergår från.
Elementet ProvisionedIngressMBps finns bara för Premium Azure Files-konton och version 2019-07-07 eller senare. Den visar etablerad ingress i MiB/s.
Elementet ProvisionedEgressMBps finns bara för Premium Azure Files-konton och version 2019-07-07 eller senare. Den visar etablerad utgående i MiB/s.
Elementet ProvisionedBandwidthMiBps finns bara för Premium Azure Files-konton och version 2021-02-12 eller senare. Den visar etablerad bandbredd (ingress + utgående kombinerad) i MiB/s.
Elementet EnableSnapshotVirtualDirectoryAccess visas endast i svarstexten i version 2024-08-04 och senare, när de aktiverade protokollen innehåller NFS. Det här elementet returneras endast för resurser, inte för ögonblicksbilder.
Elementet PaidBurstingEnabled finns bara för Premium Azure Files-konton i version 2024-11-04 eller senare. Det här elementet returneras endast för resurser, inte för ögonblicksbilder.
Elementet PaidBurstingMaxIops finns bara för Premium Azure Files-konton i version 2024-11-04 eller senare. Den returneras endast om PaidBurstingEnabled är sant för resursen. Det här elementet returneras endast för resurser, inte för ögonblicksbilder.
Elementet PaidBurstingMaxBandwidthMibps finns bara för Premium Azure Files-konton i version 2024-11-04 eller senare. Den returneras endast om PaidBurstingEnabled är sant för resursen. Det här elementet returneras endast för resurser, inte för ögonblicksbilder.

Exempelsvar

Se avsnittet Exempelbegäran och svar senare i det här avsnittet.

Tillstånd

Endast kontoägaren kan anropa den här åtgärden.

Anmärkningar

Om du anger ett värde för parametern maxresults och antalet resurser som ska returneras överskrider det här värdet eller överskrider standardvärdet för maxresultsinnehåller svarstexten ett NextMarker element. Det här elementet anger nästa resurs som ska returneras för en efterföljande begäran. Om du vill returnera nästa uppsättning objekt anger du värdet för NextMarker som markörparameter på URI:n för den efterföljande begäran.

Observera att värdet för NextMarker ska behandlas som ogenomskinlig.

Resurser visas i alfabetisk ordning i svarstexten.

Den List Shares åtgärden överskrider tidsgränsen efter 30 sekunder.

Exempel på begäran och svar

Följande exempel-URI begär listan över resurser för ett konto. Det anger det maximala resultatet som ska returneras för den första åtgärden till tre.

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

Begäran skickas med följande rubriker:

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

Statuskoden och svarshuvudena returneras på följande sätt:

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

Svarets XML för den här begäran är följande. Observera att elementet NextMarker följer resursuppsättningen och innehåller namnet på nästa resurs som ska returneras.

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

Den efterföljande liståtgärden anger markören på begärande-URI:n enligt följande. Nästa uppsättning resultat returneras från och med den resurs som anges av markören.

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

Se även

REST API för Azure Files

Dela via