Enumerar recursos compartidos

Artículo
08/07/2024

La operación List Shares 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: enumerar, 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 los recursos de FileShare mediante el proveedor de recursos de almacenamiento, consulte Operations on FileShares.

Disponibilidad del protocolo

Protocolo habilitado para recursos compartidos de archivos	Disponible
SMB
NFS

Pedir

Puede construir la solicitud List Shares de la siguiente manera. Se recomienda HTTPS.

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

Reemplace los componentes de ruta de acceso que se muestran en el URI de solicitud por el suyo propio, como se indica a continuación:

Componente de ruta de acceso	Descripción
`myaccount`	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 de 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 del 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 `maxresults`o 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 varios conjuntos de datos que se van a 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 más antigua a más reciente en la respuesta. - `metadata`: especifica que los metadatos de recurso compartido deben devolverse en la respuesta. - `deleted`: especifica que los recursos compartidos de archivos eliminados deben incluirse en la respuesta. Para especificar más de una de estas opciones en el URI, debe separar cada opción con una coma codificada por URL ("%82"). Todos los nombres de metadatos deben cumplir las convenciones de nomenclatura para identificadores de C#.
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para más información, consulte Configuración de tiempos de espera para las operaciones de Azure Files.

Encabezados de solicitud

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

Encabezado de solicitud	Descripción
`Authorization`	Obligatorio. Especifica el esquema de autorización, el nombre de la cuenta y la firma. Para más información, consulte Autorizar solicitudes a Azure Storage.
`Date` o `x-ms-date`	Obligatorio. Especifica la hora universal coordinada (UTC) de la solicitud. Para más información, consulte Autorizar solicitudes a Azure Storage.
`x-ms-version`	Necesario para todas las solicitudes autorizadas. Especifica la versión de la operación que se va a usar para esta solicitud. Para más información, consulte Control de versiones de para 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 más información, consulte Monitor Azure Files.

Cuerpo de la solicitud

Ninguno.

Respuesta

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

Código de estado

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 de esta operación incluye los siguientes encabezados. La respuesta también incluye encabezados HTTP estándar adicionales. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1 de .

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 obtener más información, consulte Solución de problemas de operaciones de API.
`x-ms-version`	Indica la versión de Azure Files que se usa 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 encabezado `x-ms-client-request-id`, si está presente en la solicitud. El valor tiene como máximo 1024 caracteres ASCII visibles. Si el encabezado `x-ms-client-request-id` no está presente en la solicitud, este encabezado no estará presente en la respuesta.

Cuerpo de la respuesta

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

El elemento EnabledProtocols aparece en el cuerpo de la respuesta solo en la versión 2020-02-10 y versiones posteriores.
El elemento RootSquash aparece en el cuerpo de la respuesta solo en la versión 2020-02-10 y versiones posteriores, cuando los protocolos habilitados contienen NFS. Este elemento solo se devolverá para los recursos compartidos, no para las instantáneas.
El elemento Quota aparece en el cuerpo de la respuesta solo en la versión 2015-02-21 y versiones posteriores.
Los elementos Version, Deleted, DeletedTimey RemainingRetentionDays aparecen en el cuerpo de la respuesta solo en la versión 2019-12-12 y posteriores.
Los elementos Prefix, Markery MaxResults solo están presentes si los especifica en el URI. El elemento NextMarker tiene un valor solo si los resultados de la lista no están completos.
El elemento Metadata solo está presente si especifica el parámetro include=metadata en el URI. Dentro del elemento Metadata, el valor de cada par nombre-valor aparece dentro de un elemento correspondiente al nombre del par.
Las instantáneas se incluyen en la respuesta solo si especifica el parámetroinclude=snapshots con el parámetro include en el URI de solicitud.
El elemento AccessTier contiene el nivel del recurso compartido. Si no se ha cambiado el nivel del recurso compartido, esta propiedad será el nivel predeterminado TransactionOptimized en las cuentas de almacenamiento de uso general 2 (GPv2). En las cuentas de almacenamiento de Azure Files, la propiedad será Premium, que es el único nivel admitido.
El elemento AccessTierChangeTime solo está presente si establece explícitamente el nivel de acceso en el recurso compartido.
El elemento AccessTierTransitionState solo está presente si el recurso compartido está pasando de un nivel a otro. Indica el nivel desde el que está realizando la transición.
El elemento ProvisionedIngressMBps solo está presente para Premium cuentas de Azure Files y la versión 2019-07-07 o posterior. Muestra la entrada aprovisionada en MiB/s.
El elemento ProvisionedEgressMBps solo está presente para Premium cuentas de Azure Files y la versión 2019-07-07 o posterior. Muestra la salida aprovisionada en MiB/s.
El elemento ProvisionedBandwidthMiBps solo está presente para Premium cuentas de Azure Files y la versión 2021-02-12 o posterior. Muestra el ancho de banda aprovisionado (entrada + salida combinada) en MiB/s.
El elemento EnableSnapshotVirtualDirectoryAccess aparece en el cuerpo de la respuesta solo en la versión 2024-08-04 y posteriores, cuando los protocolos habilitados contienen NFS. Este elemento solo se devolverá para los recursos compartidos, no para las instantáneas.
El elemento PaidBurstingEnabled solo está presente para Premium cuentas de Azure Files, en la versión 2024-11-04 o posterior. Este elemento solo se devolverá para los recursos compartidos, no para las instantáneas.
El elemento PaidBurstingMaxIops solo está presente para Premium cuentas de Azure Files, en la versión 2024-11-04 o posterior. Solo se devolverá si PaidBurstingEnabled es true para el recurso compartido. Este elemento solo se devolverá para los recursos compartidos, no para las instantáneas.
El elemento PaidBurstingMaxBandwidthMibps solo está presente para Premium cuentas de Azure Files, en la versión 2024-11-04 o posterior. Solo se devolverá si PaidBurstingEnabled es true para el recurso compartido. Este elemento solo se devolverá para los recursos compartidos, no para las instantáneas.

Respuesta de ejemplo

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

Autorización

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

Observaciones

Si especifica un valor para el parámetro maxresults y el número de recursos compartidos que se van a devolver supera este valor, o supera el valor predeterminado de maxresults, el cuerpo de la respuesta contiene un elemento NextMarker. 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 parámetro de marcador en el URI para la solicitud posterior.

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

Los recursos compartidos se muestran en orden alfabético en el cuerpo de la respuesta.

La operación List Shares agota el tiempo de espera después 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 van a devolver 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 siguiente manera:

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 XML de respuesta de esta solicitud es el siguiente. Tenga en cuenta que el elemento NextMarker 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>
      </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 operación de lista posterior especifica el marcador en el URI de solicitud, como se indica a continuación. 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

de la API REST de de Azure Files

Compartir a través de