Recursos compartidos de lista

La List Shares operación devuelve una lista de los recursos compartidos y las instantáneas de recurso compartido en la cuenta especificada. Esta API es totalmente compatible, pero es una API de administración heredada. Use recursos compartidos de archivos: enumeración, proporcionado por el proveedor de recursos de almacenamiento (Microsoft.Storage), en su lugar. Para obtener más información sobre la interacción mediante programación con FileShare los recursos mediante el proveedor de recursos de almacenamiento, consulte Operaciones en FileShares.

Disponibilidad del protocolo

Protocolo de recurso compartido de archivos habilitado Disponible
SMB Sí
NFS Sí

Request

Puede construir la List Shares solicitud como se indica a continuación. Se recomienda HTTPS.

Método URI de solicitud Versión de HTTP
GET https://myaccount.file.core.windows.net/?comp=list HTTP/1.1

Reemplace los componentes de la ruta de acceso que se muestran en el URI de solicitud por los suyos de la siguiente manera:

Componente de ruta de acceso Descripción
myaccount El nombre de la cuenta de almacenamiento.

Para más información sobre las restricciones de nomenclatura de rutas de acceso, consulte Nomenclatura y referencia a recursos compartidos, directorios, archivos y metadatos.

Parámetros del identificador URI

Puede especificar los siguientes parámetros adicionales en el URI de solicitud.

Parámetro Descripción
prefix Opcional. Filtra los resultados para devolver solo los recursos compartidos que tienen nombres que comienzan por el prefijo especificado.
marker Opcional. Valor de cadena que identifica la parte de la lista que se va a devolver con la siguiente operación de lista. La operación devuelve un valor de marcador dentro del cuerpo de la respuesta, si la lista devuelta no se completó. A continuación, puede usar el valor del marcador en una llamada posterior para solicitar el siguiente conjunto de elementos de lista.

El valor de marcador es opaco para el cliente.
maxresults Opcional. Especifica el número máximo de recursos compartidos que se van a devolver. Si la solicitud no especifica maxresultso especifica un valor mayor que 5000, el servidor devolverá hasta 5000 elementos. Si el parámetro se establece en un valor menor o igual que cero, el servidor devolverá el código de estado 400 (Solicitud incorrecta).
include=metadata,snapshots,deleted Opcional. Especifica uno o más conjuntos de datos que se deben incluir en la respuesta:

- snapshots: versión 2017-04-17 y posteriores. Especifica que las instantáneas de recurso compartido deben incluirse en la respuesta. Las instantáneas de recurso compartido se muestran de la más antigua a la más reciente en la respuesta.
- metadata: especifica que los metadatos del recurso compartido se deben devolver en la respuesta.
- deleted: especifica que los recursos compartidos de archivos eliminados deben incluirse en la respuesta.

Si desea especificar varias de estas opciones en el URI, debe separarlas mediante una coma codificada para URL ("%82").

Todos los nombres de metadatos deben cumplir las convenciones de nomenclatura de los identificadores de C#.
timeout Opcional. El parámetro timeout se expresa en segundos. Para obtener más información, consulte Configuración de tiempos de espera para operaciones de Azure Files.

Encabezados de solicitud

En la tabla siguiente se describen los encabezados de solicitud requeridos y opcionales.

Encabezado de solicitud Descripción
Authorization Necesario. Especifica el esquema de autorización, el nombre de la cuenta y la firma. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
Date o x-ms-date Necesario. Especifica la hora universal coordinada (UTC) de la solicitud. Para obtener más información, vea Autorización de solicitudes a Azure Storage.
x-ms-version Obligatorio para todas las solicitudes autorizadas. Especifica la versión de la operación que se utiliza para esta solicitud. Para obtener más información, vea Versiones de los servicios de Azure Storage.
x-ms-client-request-id Opcional. Proporciona un valor opaco generado por el cliente con un límite de caracteres de 1 kibibyte (KiB) que se registra en los registros cuando se configura el registro. Se recomienda encarecidamente usar este encabezado para correlacionar las actividades del lado cliente con las solicitudes que recibe el servidor. Para obtener más información, vea Supervisar Azure Files.

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP, un conjunto de encabezados de respuesta y un cuerpo de respuesta en formato XML.

status code

Una operación correcta devuelve el código de estado 200 Correcto. Para obtener información sobre los códigos de estado, vea Códigos de estado y de error.

Encabezados de respuesta

La respuesta para esta operación incluye los encabezados siguientes. La respuesta también incluye encabezados HTTP adicionales y estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.

Encabezado de respuesta Descripción
Content-Type Encabezado HTTP/1.1 estándar. Especifica el formato en el que se devuelven los resultados. Actualmente, este valor es application/xml.
x-ms-request-id Este encabezado identifica de forma única la solicitud que se realizó y se puede usar para solucionar problemas de la solicitud. Para más información, consulte Solución de problemas de operaciones de API.
x-ms-version Indica la versión de Azure Files usada para ejecutar la solicitud.
Date o x-ms-date Valor de fecha y hora UTC que indica la hora a la que se inició la respuesta. El servicio genera este valor.
x-ms-client-request-id Puede usar este encabezado para solucionar problemas de solicitudes y respuestas correspondientes. El valor de este encabezado es igual al valor del x-ms-client-request-id encabezado, si está presente en la solicitud. El valor es como máximo 1024 caracteres ASCII visibles. Si el x-ms-client-request-id encabezado no está presente en la solicitud, este encabezado no estará presente en la respuesta.

Response body

El formato del cuerpo de la respuesta es el siguiente.

<?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>  
  • El EnabledProtocols elemento aparece en el cuerpo de la respuesta solo en la versión 2020-02-10 y posteriores.
  • El RootSquash elemento aparece en el cuerpo de la respuesta solo en la versión 2020-02-10 y posteriores, cuando los protocolos habilitados contienen NFS.
  • El Quota elemento aparece en el cuerpo de la respuesta solo en la versión 2015-02-21 y versiones posteriores.
  • Los Versionelementos , Deleted, DeletedTimey RemainingRetentionDays aparecen en el cuerpo de la respuesta solo en la versión 2019-12-12 y posteriores.
  • Los Prefixelementos , Markery MaxResults solo están presentes si los especifica en el URI. El NextMarker elemento solo tiene un valor si los resultados de la lista no están completos.
  • El Metadata elemento solo está presente si especifica el include=metadata parámetro en el URI. Dentro del elemento Metadata, el valor de cada par nombre-valor aparece en un elemento que corresponde al nombre del par.
  • Las instantáneas se incluyen en la respuesta solo si especifica elinclude=snapshots parámetro con el parámetro en el include URI de solicitud.
  • El AccessTier elemento contiene el nivel del recurso compartido. Si no se ha cambiado el nivel del recurso compartido, esta propiedad será el nivel TransactionOptimized predeterminado en las cuentas de almacenamiento de uso general versión 2 (GPv2). En Azure Files cuentas de almacenamiento, la propiedad será Premium, que es el único nivel admitido.
  • El AccessTierChangeTime elemento solo está presente si establece explícitamente el nivel de acceso en el recurso compartido.
  • El AccessTierTransitionState elemento solo está presente si el recurso compartido realiza la transición de un nivel a otro. Indica el nivel desde el que realiza la transición.
  • El ProvisionedIngressMBps elemento solo está presente para Premium las cuentas de Azure Files y la versión 2019-07-07 o posterior. Muestra la entrada aprovisionada en MiB/s.
  • El ProvisionedEgressMBps elemento solo está presente para Premium las cuentas de Azure Files y la versión 2019-07-07 o posterior. Muestra la salida aprovisionada en MiB/s.
  • El ProvisionedBandwidthMiBps elemento solo está presente para Premium Azure Files cuentas y la versión 2021-02-12 o posterior. Muestra el ancho de banda aprovisionado (entrada + salida combinada) en MiB/s.

Respuesta de muestra

Consulte la sección Solicitud y respuesta de ejemplo más adelante en este tema.

Authorization

Solo el propietario de la cuenta puede llamar a esta operación.

Comentarios

Si especifica un valor para el maxresults parámetro y el número de recursos compartidos que se van a devolver supera este valor o supera el valor predeterminado para maxresults, el cuerpo de la respuesta contiene un NextMarker elemento . Este elemento indica el siguiente recurso compartido que se va a devolver en una solicitud posterior. Para devolver el siguiente conjunto de elementos, especifique el valor de NextMarker como el parámetro de marcador en el URI para la solicitud siguiente.

Tenga en cuenta que el valor de NextMarker se debe tratar como opaco.

Los recursos compartidos aparecen en orden alfabético en el cuerpo de respuesta.

La operación List Shares agota el tiempo de espera al cabo de 30 segundos.

Solicitud y respuesta de ejemplo

El siguiente URI de ejemplo solicita la lista de recursos compartidos de una cuenta. Establece los resultados máximos que se devolverán para la operación inicial en tres.

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

La solicitud se envía con estos encabezados:

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

El código de estado y los encabezados de respuesta se devuelven de la forma siguiente:

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  

El código XML de respuesta para esta solicitud es el siguiente. Tenga en cuenta que el NextMarker elemento sigue el conjunto de recursos compartidos e incluye el nombre del siguiente recurso compartido que se va a devolver.

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

La subsiguiente operación de lista especifica el marcador en el URI de la solicitud, de la forma siguiente. Se devuelve el siguiente conjunto de resultados, empezando por el recurso compartido especificado por el marcador.

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

Consulte también

API REST de Azure Files