Elenco di condivisioni

Articolo
07/19/2023

L'operazione List Shares restituisce un elenco delle condivisioni e degli snapshot di condivisione nell'account specificato. Questa API è completamente supportata, ma è un'API di gestione legacy. Usare condivisioni file : elenco, fornito dal provider di risorse di archiviazione (Microsoft.Storage), invece. Per altre informazioni sull'interazione a livello di codice con FileShare le risorse usando il provider di risorse di archiviazione, vedere Operazioni su FileShares.

Disponibilità del protocollo

Protocollo di condivisione file abilitato	Disponibile
SMB
NFS

Richiesta

È possibile costruire la List Shares richiesta come indicato di seguito. È consigliato il protocollo HTTPS.

Metodo	URI richiesta	Versione HTTP
`GET`	`https://myaccount.file.core.windows.net/?comp=list`	HTTP/1.1

Sostituire i componenti del percorso mostrati nell'URI di richiesta con valori personalizzati, come illustrato di seguito:

Componente percorso	Descrizione
`myaccount`	nome dell'account di archiviazione.

Per informazioni dettagliate sulle restrizioni di denominazione del percorso, vedere Denominazione e riferimento a condivisioni, directory, file e metadati.

Parametri URI

È possibile specificare i parametri aggiuntivi seguenti nell'URI della richiesta.

Parametro	Descrizione
`prefix`	Facoltativa. Filtra i risultati per restituire solo condivisioni con nomi che iniziano con il prefisso specificato.
`marker`	Facoltativa. Valore stringa che identifica la parte dell'elenco da restituire con l'operazione elenco successiva. L'operazione restituisce un valore di marcatore all'interno del corpo della risposta, se l'elenco restituito non è stato completato. È quindi possibile usare il valore del marcatore in una chiamata successiva per richiedere il set successivo di elementi di elenco. Il valore marcatore risulta opaco al client.
`maxresults`	Facoltativa. Specifica il numero massimo di condivisioni da restituire. Se la richiesta non specifica `maxresults`o specifica un valore maggiore di 5.000, il server restituirà fino a 5.000 elementi. Se il parametro è impostato su un valore minore o uguale a zero, il server restituirà il codice di stato 400 (Richiesta non valida).
`include=metadata,snapshots,deleted`	Facoltativa. Specifica uno o più set di dati da includere nella risposta: - `snapshots`: versione 2017-04-17 e successiva. Specifica che gli snapshot di condivisione devono essere inclusi nella risposta. Gli snapshot di condivisione sono elencati dal meno recente al più recente nella risposta. - `metadata`: specifica che i metadati di condivisione devono essere restituiti nella risposta. - `deleted`: specifica che le condivisioni file eliminate devono essere incluse nella risposta. Per specificare più di una di queste opzioni nell'URI, è necessario separare ogni opzione con una virgola con codifica URL ("%82"). Tutti i nomi dei metadati devono rispettare le convenzioni di denominazione per gli identificatori C#.
`timeout`	Facoltativa. Il parametro `timeout` viene espresso in secondi. Per altre informazioni, vedere Impostazione dei timeout per le operazioni di File di Azure.

Intestazioni della richiesta

Nella seguente tabella vengono descritte le intestazioni di richiesta obbligatorie e facoltative.

Intestazione della richiesta	Descrizione
`Authorization`	Obbligatorio. Specifica lo schema di autorizzazione, il nome dell'account e la firma. Per altre informazioni, vedere Autorizzare le richieste ad Archiviazione di Azure.
`Date` o `x-ms-date`	Obbligatorio. Specifica la data per la richiesta nel fuso orario UTC (Coordinated Universal Time). Per altre informazioni, vedere Autorizzare le richieste ad Archiviazione di Azure.
`x-ms-version`	Obbligatorio per tutte le richieste autorizzate. Specifica la versione dell'operazione da usare per questa richiesta. Per altre informazioni, vedere Controllo delle versioni per i servizi di archiviazione di Azure.
`x-ms-client-request-id`	Facoltativa. Fornisce un valore opaco generato dal client con un limite di caratteri di 1 kibibyte (KiB) registrato nei log quando la registrazione è configurata. È consigliabile usare questa intestazione per correlare le attività lato client con le richieste ricevute dal server. Per altre informazioni, vedere Monitorare File di Azure.

Testo della richiesta

Nessuno.

Risposta

Nella risposta sono inclusi un codice di stato HTTP, un set di intestazioni di risposta e il corpo della risposta nel formato XML.

Codice stato

Un'operazione completata correttamente restituisce 200 (OK). Per informazioni sui codici di stato, vedere Codici di stato e di errore.

Intestazioni di risposta

Nella risposta per questa operazione sono incluse le intestazioni riportate di seguito; La risposta include anche intestazioni HTTP aggiuntive e standard. Tutte le intestazioni standard sono conformi alla specifica del protocollo HTTP/1.1.

Intestazione risposta	Descrizione
`Content-Type`	Intestazione HTTP/1.1 standard. Specifica il formato in cui vengono restituiti i risultati. Attualmente, questo valore è `application/xml`.
`x-ms-request-id`	Questa intestazione identifica in modo univoco la richiesta effettuata e può essere usata per la risoluzione dei problemi della richiesta. Per altre informazioni, vedere Risoluzione dei problemi relativi alle operazioni api.
`x-ms-version`	Indica la versione di File di Azure usata per eseguire la richiesta.
`Date` o `x-ms-date`	Valore di data/ora UTC che indica l'ora in cui è stata avviata la risposta. Il servizio genera questo valore.
`x-ms-client-request-id`	È possibile usare questa intestazione per risolvere le richieste e le risposte corrispondenti. Il valore di questa intestazione è uguale al valore dell'intestazione `x-ms-client-request-id` , se presente nella richiesta. Il valore è al massimo 1024 caratteri ASCII visibili. Se l'intestazione `x-ms-client-request-id` non è presente nella richiesta, questa intestazione non sarà presente nella risposta.

Corpo della risposta

Il formato del corpo della risposta è quello indicato di seguito.

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

L'elemento EnabledProtocols viene visualizzato nel corpo della risposta solo nella versione 2020-02-10 e versioni successive.
L'elemento RootSquash viene visualizzato nel corpo della risposta solo nella versione 2020-02-10 e successive, quando i protocolli abilitati contengono NFS.
L'elemento Quota viene visualizzato nel corpo della risposta solo nella versione 2015-02-21 e successive.
Gli Versionelementi , Deleted, DeletedTimee RemainingRetentionDays vengono visualizzati nel corpo della risposta solo nella versione 2019-12-12 e successive.
Gli Prefixelementi , Markere MaxResults sono presenti solo se vengono specificati nell'URI. L'elemento NextMarker ha un valore solo se i risultati dell'elenco non sono completi.
L'elemento Metadata è presente solo se si specifica il include=metadata parametro nell'URI. Nell'elemento Metadata il valore di ogni coppia nome-valore è elencato in un elemento corrispondente al nome della coppia.
Gli snapshot vengono inclusi nella risposta solo se si specifica ilinclude=snapshots parametro con il include parametro nell'URI della richiesta.
L'elemento AccessTier contiene il livello della condivisione. Se il livello della condivisione non è stato modificato, questa proprietà sarà il livello TransactionOptimized predefinito negli account di archiviazione per utilizzo generico versione 2 (GPv2). In File di Azure account di archiviazione, la proprietà sarà Premium, che è l'unico livello supportato.
L'elemento AccessTierChangeTime è presente solo se si imposta in modo esplicito il livello di accesso nella condivisione.
L'elemento AccessTierTransitionState è presente solo se la condivisione passa da un livello a un altro. Indica il livello da cui viene eseguita la transizione.
L'elemento ProvisionedIngressMBps è presente solo per Premium gli account File di Azure e la versione 2019-07-07 o successiva. Mostra l'ingresso di cui è stato effettuato il provisioning in MiB/s.
L'elemento ProvisionedEgressMBps è presente solo per Premium gli account File di Azure e la versione 2019-07-07 o successiva. Mostra l'uscita di cui è stato effettuato il provisioning in MiB/s.
L'elemento ProvisionedBandwidthMiBps è presente solo per Premium gli account File di Azure e versione 2021-02-12 o successiva. Mostra la larghezza di banda con provisioning (in ingresso + uscita combinata) in MiB/s.

Risposta di esempio

Vedere la sezione Richiesta e risposta di esempio più avanti in questo argomento.

Autorizzazione

Solo il proprietario dell'account può chiamare questa operazione.

Commenti

Se si specifica un valore per il maxresults parametro e il numero di condivisioni da restituire supera questo valore o supera il valore predefinito per maxresults, il corpo della risposta contiene un NextMarker elemento . Questo elemento indica la condivisione successiva da restituire in una richiesta successiva. Per restituire il set successivo di elementi, specificare il valore NextMarker come parametro marcatore nell'URI per la richiesta successiva.

Si noti che il valore NextMarker deve essere considerato opaco.

Le condivisioni sono elencate in ordine alfabetico nel corpo della risposta.

L'operazione List Shares scade dopo 30 secondi.

Richiesta e risposta di esempio

L'URI di esempio seguente richiede l'elenco di condivisioni per un account. Imposta i risultati massimi da restituire per l'operazione iniziale su tre.

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

La richiesta viene inviata con queste intestazioni:

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

Il codice di stato e le intestazioni della risposta vengono restituiti nel modo seguente:

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

L'XML della risposta per questa richiesta è il seguente. Si noti che l'elemento NextMarker segue il set di condivisioni e include il nome della condivisione successiva da restituire.

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

L'operazione elenco successiva specifica il marcatore nell'URI della richiesta, come illustrato di seguito. Viene restituito il set di risultati successivo, a partire dalla condivisione specificata dal marcatore.

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

Vedi anche

API REST File di Azure