Výpis sdílených složek

Článek
08/07/2024

Operace List Shares vrátí seznam sdílených složek a snímků sdílených složek v rámci zadaného účtu. Toto rozhraní API je plně podporované, ale jedná se o starší rozhraní API pro správu. Místo toho použijte sdílené složky – seznam, který poskytuje poskytovatel prostředků úložiště (Microsoft.Storage). Další informace o programové interakci s FileShare prostředky pomocí poskytovatele prostředků úložiště najdete v tématu Operace se sdílenými složkami.

Dostupnost protokolu

Povolený protokol sdílené složky	K dispozici
SMB
NFS

Prosba

Požadavek List Shares můžete vytvořit následujícím způsobem. Doporučuje se HTTPS.

Metoda	Identifikátor URI požadavku	Verze HTTP
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

Součásti cesty zobrazené v identifikátoru URI požadavku nahraďte vlastními, a to následujícím způsobem:

Komponenta Path	Popis
`myaccount`	Název vašeho účtu úložiště.

Podrobnosti o omezeních pojmenování cest najdete v tématu Pojmenování a odkazování na sdílené složky, adresáře, soubory a metadata.

Parametry identifikátoru URI

Pro identifikátor URI požadavku můžete zadat následující další parametry.

Parametr	Popis
`prefix`	Volitelný. Filtruje výsledky tak, aby vracely jenom sdílené složky, které mají názvy začínající zadanou předponou.
`marker`	Volitelný. Řetězcová hodnota, která identifikuje část seznamu, která se má vrátit pomocí další operace seznamu. Operace vrátí hodnotu značky v textu odpovědi, pokud vrácený seznam nebyl dokončen. Hodnotu značky pak můžete použít v následném volání a požádat o další sadu položek seznamu. Hodnota značky je pro klienta neprůhelní.
`maxresults`	Volitelný. Určuje maximální počet sdílených složek, které se mají vrátit. Pokud požadavek nezadá `maxresults`nebo zadá hodnotu větší než 5 000, server vrátí až 5 000 položek. Pokud je parametr nastaven na hodnotu menší nebo rovno nule, server vrátí stavový kód 400 (Chybný požadavek).
`include=metadata,snapshots,deleted`	Volitelný. Určuje jednu nebo více datových sad, které se mají zahrnout do odpovědi: - `snapshots`: Verze 2017-04-17 a novější. Určuje, že snímky sdílených složek by měly být zahrnuty do odpovědi. Snímky sdílených složek jsou uvedené od nejstarších po nejnovější v odpovědi. - `metadata`: Určuje, že se mají v odpovědi vrátit metadata sdílené složky. - `deleted`: Určuje, že odstraněné sdílené složky by měly být zahrnuty do odpovědi. Pokud chcete pro identifikátor URI zadat více než jednu z těchto možností, musíte každou možnost oddělit čárkou zakódovanou adresou URL ("%82"). Všechny názvy metadat musí dodržovat zásady vytváření názvů pro identifikátory jazyka C# .
`timeout`	Volitelný. Parametr `timeout` se vyjadřuje v sekundách. Další informace najdete v tématu Nastavení časových limitů pro operace azure Files.

Hlavičky požadavku

Následující tabulka popisuje povinné a volitelné hlavičky požadavků.

Hlavička požadavku	Popis
`Authorization`	Požadovaný. Určuje schéma autorizace, název účtu a podpis. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage.
`Date` nebo `x-ms-date`	Požadovaný. Určuje standard UTC (Coordinated Universal Time) pro požadavek. Další informace najdete v tématu Autorizace požadavků na službu Azure Storage.
`x-ms-version`	Vyžaduje se pro všechny autorizované žádosti. Určuje verzi operace, která se má pro tento požadavek použít. Další informace najdete v tématu Správa verzí pro služby Azure Storage.
`x-ms-client-request-id`	Volitelný. Poskytuje hodnotu vygenerovanou klientem, neprůshlenou hodnotou s limitem znaků 1 kibibajtů (KiB), který je zaznamenán v protokolech při konfiguraci protokolování. Důrazně doporučujeme použít tuto hlavičku ke korelaci aktivit na straně klienta s požadavky, které server přijímá. Další informace najdete v tématu Monitorování služby Azure Files.

Text požadavku

Žádný.

Odpověď

Odpověď obsahuje stavový kód HTTP, sadu hlaviček odpovědí a text odpovědi ve formátu XML.

Stavový kód

Úspěšná operace vrátí stavový kód 200 (OK). Informace o stavových kódech naleznete v tématu Stav a kódy chyb.

Hlavičky odpovědi

Odpověď pro tuto operaci obsahuje následující hlavičky. Odpověď obsahuje také další standardní hlavičky HTTP. Všechny standardní hlavičky odpovídají specifikaci protokolu HTTP/1.1.

Hlavička odpovědi	Popis
`Content-Type`	Standardní hlavička HTTP/1.1. Určuje formát, ve kterém se vrátí výsledky. V současné době je tato hodnota `application/xml`.
`x-ms-request-id`	Tato hlavička jednoznačně identifikuje požadavek, který byl proveden, a lze ho použít k řešení potíží s požadavkem. Další informace najdete v tématu řešení potíží s operacemi rozhraní API.
`x-ms-version`	Označuje verzi služby Azure Files použitou ke spuštění požadavku.
`Date` nebo `x-ms-date`	Hodnota data a času UTC, která označuje čas, kdy byla odpověď zahájena. Služba vygeneruje tuto hodnotu.
`x-ms-client-request-id`	Tato hlavička slouží k řešení potíží s požadavky a odpovídajícími odpověďmi. Hodnota této hlavičky se rovná hodnotě hlavičky `x-ms-client-request-id`, pokud se nachází v požadavku. Hodnota je maximálně 1024 viditelných znaků ASCII. Pokud v požadavku není hlavička `x-ms-client-request-id`, nebude tato hlavička v odpovědi k dispozici.

Text odpovědi

Formát textu odpovědi je následující.

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

Prvek EnabledProtocols se zobrazí v textu odpovědi pouze ve verzi 2020-02-10 a novější.
Prvek RootSquash se zobrazí v textu odpovědi pouze ve verzi 2020-02-02-10 a novější, pokud povolené protokoly obsahují systém souborů NFS. Tento prvek bude vrácen pouze pro sdílené složky, ne pro snímky.
Prvek Quota se zobrazí v textu odpovědi pouze ve verzi 2015-02-21 a novější.
Prvky Version, Deleted, DeletedTimea RemainingRetentionDays se zobrazí v textu odpovědi pouze ve verzi 2019-12-12 a novější.
Prvky Prefix, Markera MaxResults jsou k dispozici pouze v případě, že je zadáte v identifikátoru URI. Prvek NextMarker má hodnotu pouze v případě, že výsledky seznamu nejsou dokončeny.
Element Metadata je k dispozici pouze v případě, že v identifikátoru URI zadáte parametr include=metadata. V elementu Metadata je hodnota každého páru name-value uvedena v elementu odpovídajícím názvu dvojice.
Snímky jsou součástí odpovědi pouze v případě, že zadáte parametrinclude=snapshots s parametrem include na identifikátoru URI požadavku.
Prvek AccessTier obsahuje úroveň sdílené složky. Pokud úroveň sdílené složky nebyla změněna, bude tato vlastnost výchozí vrstvou TransactionOptimized pro účty úložiště pro obecné účely verze 2 (GPv2). U účtů úložiště Azure Files bude tato vlastnost Premium, což je jediná podporovaná úroveň.
Element AccessTierChangeTime je k dispozici pouze v případě, že explicitně nastavíte úroveň přístupu ve sdílené složce.
Prvek AccessTierTransitionState je k dispozici pouze v případě, že sdílená složka přechází z jedné vrstvy na jinou. Označuje úroveň, ze které přechází.
Element ProvisionedIngressMBps je k dispozici pouze pro účty Premium Azure Files a verze 2019-07-07 nebo novější. Zobrazuje zřízené příchozí přenosy dat v MiB/s.
Element ProvisionedEgressMBps je k dispozici pouze pro účty Premium Azure Files a verze 2019-07-07 nebo novější. Zobrazuje zřízené výchozí přenosy dat v MiB/s.
Element ProvisionedBandwidthMiBps je k dispozici pouze pro účty Premium Azure Files a verze 2021-02-12 nebo novější. Zobrazuje zřízenou šířku pásma (příchozí a výchozí přenos v kombinaci) v MiB/s.
Prvek EnableSnapshotVirtualDirectoryAccess se zobrazí v textu odpovědi pouze ve verzi 2024-08-04 a novější, pokud povolené protokoly obsahují systém souborů NFS. Tento prvek bude vrácen pouze pro sdílené složky, ne pro snímky.
Element PaidBurstingEnabled je k dispozici pouze pro účty Premium Azure Files ve verzi 2024–11-04 nebo novější. Tento prvek bude vrácen pouze pro sdílené složky, ne pro snímky.
Element PaidBurstingMaxIops je k dispozici pouze pro účty Premium Azure Files ve verzi 2024–11-04 nebo novější. Vrátí se pouze v případě, že je hodnota PaidBurstingEnabled pro sdílenou složku pravdivá. Tento prvek bude vrácen pouze pro sdílené složky, ne pro snímky.
Element PaidBurstingMaxBandwidthMibps je k dispozici pouze pro účty Premium Azure Files ve verzi 2024–11-04 nebo novější. Vrátí se pouze v případě, že je hodnota PaidBurstingEnabled pro sdílenou složku pravdivá. Tento prvek bude vrácen pouze pro sdílené složky, ne pro snímky.

Ukázková odpověď

Viz část Ukázková žádost a odpověď dále v tomto tématu.

Oprávnění

Tuto operaci může volat pouze vlastník účtu.

Poznámky

Pokud zadáte hodnotu pro parametr maxresults a počet sdílených složek, které se mají vrátit, překročí tuto hodnotu nebo překročí výchozí hodnotu pro maxresults, text odpovědi obsahuje prvek NextMarker. Tento prvek označuje další sdílenou složku, která se má vrátit k následnému požadavku. Pokud chcete vrátit další sadu položek, zadejte hodnotu NextMarker jako parametr značky na identifikátoru URI pro následující požadavek.

Všimněte si, že hodnota NextMarker by měla být považována za neprůhlenou.

Sdílené složky jsou uvedené v abecedním pořadí v textu odpovědi.

Operace List Shares vyprší po 30 sekundách.

Ukázkový požadavek a odpověď

Následující ukázkový identifikátor URI požaduje seznam sdílených složek pro účet. Nastaví maximální počet výsledků pro vrácení počáteční operace na tři.

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

Požadavek se odešle s těmito hlavičkami:

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

Stavový kód a hlavičky odpovědi se vrátí takto:

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

Kód XML odpovědi pro tento požadavek je následující. Všimněte si, že NextMarker prvek se řídí sadou sdílených složek a obsahuje název další sdílené složky, která se má vrátit.

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

Následující operace seznamu určuje značku identifikátoru URI požadavku následujícím způsobem. Vrátí se další sada výsledků počínaje sdílenou složkou určenou značkou.

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

Viz také

rozhraní REST API služby Azure Files

Sdílet prostřednictvím