Obtención de propiedades de recursos compartidos

La Get Share Properties solicitud devuelve propiedades para el recurso compartido o la instantánea de recurso compartido especificados.

Aunque esta API es totalmente compatible, es una API de administración heredada. Por este motivo, se recomienda usar recursos compartidos de archivos: Obtener, que proporciona 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í

Solicitud

La solicitud Get Share Properties se puede construir como sigue. Se recomienda usar HTTPS.

Método URI de solicitud Versión de HTTP
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share HTTP/1.1
GET/HEAD https://myaccount.file.core.windows.net/myshare?restype=share&sharesnapshot=<DateTime> 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.
myshare El nombre del recurso compartido de archivos.

Para obtener información sobre las restricciones de nomenclatura de rutas de acceso, vea Recursos compartidos de nombres y referencia, directorios, archivos y metadatos.

Parámetros del identificador URI

Los parámetros adicionales siguientes se pueden especificar en el URI de solicitud:

Parámetro Descripción
sharesnapshot Opcional. Versión 2017-04-17 y posteriores. El sharesnapshot parámetro es un valor opaco de fecha y hora que, cuando está presente, especifica la instantánea de recurso compartido que se va a consultar para recuperar las propiedades.
timeout Opcional. El parámetro de tiempo de espera se expresa en segundos. Para obtener más información, consulte Establecer tiempos de espera para las operaciones de Azure Files.

Encabezados de solicitud

Los encabezados obligatorios y opcionales se describen en la tabla siguiente:

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.
x-ms-lease-id:<ID> Opcional. Versión 2020-02-10 y posteriores. Si se especifica el encabezado, la operación solo se realiza si la concesión del recurso compartido de archivos está activa actualmente y el identificador de concesión especificado en la solicitud coincide con el identificador de concesión del recurso compartido de archivos. Si no hay ninguna coincidencia, se produce un error en la operación con el código de estado 412 (error de condición previa).

Cuerpo de la solicitud

Ninguno.

Response

La respuesta incluye un código de estado HTTP y un conjunto de encabezados de respuesta.

status code

Una operación correcta devuelve el código de estado 200 Correcto.

Para obtener más 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 puede incluir otros encabezados HTTP estándar. Todos los encabezados estándar se ajustan a la especificación del protocolo HTTP/1.1.

Encabezado de respuesta Descripción
Last-Modified Devuelve la fecha y hora en que se modificó por última vez el recurso compartido. El formato de la fecha sigue las convenciones de RFC 1123. Para obtener más información, vea Representación de valores de Date-Time en encabezados. Cualquier operación que modifique el recurso compartido o sus propiedades actualiza la hora de la última modificación. Las operaciones en archivos no afectan a la hora de la última modificación del recurso compartido.
x-ms-meta-name:value Un conjunto de pares nombre-valor que contiene los metadatos definidos por el usuario del recurso compartido.
ETag Contiene un valor que puede usar para realizar operaciones condicionalmente. El valor se incluye entre comillas.
x-ms-request-id 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 Versión Azure Files que se usó para ejecutar la solicitud.
Date Valor de fecha y hora UTC generado por el servicio, que indica la hora a la que se inició la respuesta.
x-ms-share-quota Versión 2015-02-21 y posteriores. Devuelve la cuota de acciones actual en gibibytes (GiB).
x-ms-share-provisioned-iops Versión 2019-07-07 y posteriores. Solo se devuelve para recursos compartidos de archivos Premium (recursos compartidos de archivos dentro del tipo de cuenta de almacenamiento FileStorage). Devuelve el número de operaciones de entrada y salida por segundo (IOPS), tal como se aprovisiona para el recurso compartido Premium.
x-ms-share-provisioned-ingress-mbps Versión 2019-07-07 y posteriores. Solo se devuelve para recursos compartidos de archivos Premium (recursos compartidos de archivos dentro del tipo de cuenta de almacenamiento FileStorage). Devuelve la entrada en mebibytes por segundo (MiB/s), como se aprovisiona para el recurso compartido premium.
x-ms-share-provisioned-egress-mbps Versión 2019-07-07 y posteriores. Solo se devuelve para recursos compartidos de archivos Premium (recursos compartidos de archivos dentro del tipo de cuenta de almacenamiento FileStorage). Devuelve la salida en MiB/s, tal como se aprovisiona para el recurso compartido premium.
x-ms-share-provisioned-bandwidth-mibps Versión 2021-02-12 y posteriores. Solo se devuelve para recursos compartidos de archivos Premium (recursos compartidos de archivos dentro del tipo de cuenta de almacenamiento FileStorage). Devuelve el ancho de banda combinado (entrada y salida) en MiB/s, como se aprovisiona para el recurso compartido Premium.
x-ms-share-next-allowed-quota-downgrade-time Versión 2019-07-07 y posteriores. Solo se devuelve para recursos compartidos de archivos Premium (recursos compartidos de archivos dentro del tipo de cuenta de almacenamiento FileStorage). Valor de fecha y hora que especifica cuándo se permite reducir la cuota del recurso compartido de archivos Premium. El formato de la fecha sigue las convenciones de RFC 1123.
x-ms-access-tier Versión 2019-12-12 y posteriores. Devuelve el nivel de acceso actual del recurso compartido. En las cuentas TransationOptimized de almacenamiento de uso general versión 2 (GPv2), es el nivel predeterminado del recurso compartido. En FileStorage storage account types (Tipos de cuenta de almacenamiento de FileStorage), Premium es el nivel predeterminado del recurso compartido.
x-ms-access-tier-change-time Versión 2019-12-12 y posteriores. Devuelve la fecha y hora en que se modificó por última vez el nivel de acceso en el recurso compartido.
x-ms-access-tier-transition-state Versión 2019-12-12 y posteriores. Si el recurso compartido está realizando la transición de nivel, este encabezado indica el nivel desde el que realiza la transición.
x-ms-lease-duration:<fixed,infinite> Versión 2020-02-10 y posteriores. Especifica si la concesión de un recurso compartido tiene una duración infinita o fija.
x-ms-lease-state: <available;leased;expired;breaking;broken> Versión 2020-02-10 y posteriores. Cuando se alquila un recurso compartido, este encabezado especifica el estado de concesión del recurso compartido.
x-ms-lease-status: <locked;unlocked> Versión 2020-02-10 y posteriores. Cuando se alquila un recurso compartido, este encabezado especifica el estado de concesión del recurso compartido.
x-ms-enabled-protocols: <SMB;NFS> Devuelve los protocolos actuales habilitados para recursos compartidos para la versión 2019-07-07 y posteriores.

- SMB: SMBv3.0, SMBv2.1 y REST pueden acceder al recurso compartido.
- NFS: NFSv4.1 puede acceder al recurso compartido.
x-ms-root-squash: <NoRootSquash;RootSquash;AllSquash> Devuelve el comportamiento de squash de raíz del recurso compartido actual para la versión 2019-07-07 y posteriores. Solo NFS.

- NoRootSquash: el aplastamiento raíz está desactivado.
- RootSquash: las solicitudes de UID/GID 0 se asignan al UID/GID anónimo.
- AllSquash: todos los UID y GID se asignan al usuario anónimo.
x-ms-client-request-id Se puede usar 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 y el valor no contiene más de 1024 caracteres ASCII visibles. Si el x-ms-client-request-id encabezado no está presente en la solicitud, no estará presente en la respuesta.

Response body

Ninguno.

Respuesta de muestra

Response Status:  
HTTP/1.1 200 OK  
  
Response Headers:  
Transfer-Encoding: chunked  
x-ms-meta-name: some_metadata  
Date: <date>  
ETag: "0x8CB171DBEAD6A6B"  
Last-Modified: <date>  
x-ms-share-quota: 1024
x-ms-access-tier: Premium
x-ms-version: 2020-02-10  
x-ms-enabled-protocols: NFS
x-ms-root-squash: RootSquash
Server: Windows-Azure-File/1.0 Microsoft-HTTPAPI/2.0  

Authorization

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

Observaciones

Ninguno.

Consulte también

Operaciones en recursos compartidos de archivos de Azure