Get Container Properties

Artículo
02/14/2024

La operación Get File Properties devuelve todos los metadatos definidos por el usuario, las propiedades HTTP estándar y las propiedades del sistema para el archivo. No devuelve el contenido del archivo.

Disponibilidad del protocolo

Protocolo de recurso compartido de archivos habilitado	Disponible
SMB
NFS

Solicitud

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

Método	URI de solicitud	Versión de HTTP
`HEAD`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile`	HTTP/1.1
`HEAD`	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?sharesnapshot=<DateTime>`	HTTP/1.1

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

Componente de ruta de acceso	Descripción
`myaccount`	El nombre de la cuenta de almacenamiento.
`myshare`	El nombre del recurso compartido de archivos.
`mydirectorypath`	Opcional. La ruta de acceso al directorio principal.
`myfile`	Nombre del archivo.

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

Se pueden especificar los siguientes parámetros adicionales 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 DateTime opaco que, cuando está presente, especifica la instantánea de recurso compartido que se va a consultar para las propiedades del archivo.
`timeout`	Opcional. El parámetro `timeout` se expresa en segundos. Para obtener más información, vea Establecer tiempos de espera para las operaciones de Azure Files.

Encabezados de solicitud

Los encabezados de solicitud 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-lease-id:<ID>`	Opcional. Versión 2019-02-02 y posteriores. Si se especifica el encabezado, la operación solo se realiza si la concesión del archivo está activa actualmente y el identificador de concesión especificado en la solicitud coincide con el identificador de concesión del archivo. Si no coincide, se produce un error en la operación con el código de estado 412 (error de condición previa).
`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 de análisis cuando azure Storage Analytics registro está habilitado. Se recomienda encarecidamente usar este encabezado al correlacionar las actividades del lado cliente con las solicitudes recibidas por el servidor. Para obtener más información, vea Supervisar Azure Blob Storage.
`x-ms-file-request-intent`	Obligatorio si `Authorization` el encabezado especifica un token de OAuth. El valor aceptable es `backup`. Este encabezado especifica que se debe conceder o `Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` si se incluyen en la directiva de RBAC asignada a la identidad autorizada mediante el `Authorization` encabezado . Disponible para la versión 2022-11-02 y posteriores.
`x-ms-allow-trailing-dot: { <Boolean> }`	Opcional. Versión 2022-11-02 y posteriores. El valor booleano especifica si se debe recortar o no un punto final presente en la dirección URL de la solicitud. Para obtener más información, consulte Nomenclatura y referencia a recursos compartidos, directorios, archivos y metadatos.

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 archivo. El formato de la fecha sigue las convenciones de RFC 1123. Para obtener más información, vea Representar valores de fecha y hora en encabezados. Cualquier operación que modifique el archivo o sus propiedades actualiza la hora de la última modificación.
`x-ms-meta-name:value`	Conjunto de pares nombre-valor asociados a este archivo como metadatos definidos por el usuario.
`x-ms-type: <File>`	Devuelve el tipo `File`. Reservado para uso futuro.
`Content-Length`	El tamaño del archivo en bytes. Este encabezado devuelve el valor del `x-ms-content-length` encabezado que se almacena con el archivo.
`Content-Type`	Tipo de contenido especificado para el archivo. Si no se especifica ningún tipo de contenido, el tipo de contenido predeterminado es `application/octet-stream`.
`ETag`	La ETag contiene un valor que se puede utilizar para realizar operaciones condicionales. El valor se incluye entre comillas.
`Content-MD5`	Si se ha establecido el encabezado `Content-MD5` para el archivo, se devuelve el encabezado de respuesta `Content-MD5` para que el cliente pueda comprobar la integridad del contenido del mensaje.
`Content-Encoding`	Si anteriormente se estableció el encabezado de solicitud `Content-Encoding` para el archivo, se devuelve el valor de `Content-Encoding` en el encabezado.
`Content-Language`	Si anteriormente se estableció el encabezado de solicitud `Content-Language` para el archivo, se devuelve el valor de `Content-Language` en el encabezado.
`Cache-Control`	Si anteriormente se estableció el encabezado de solicitud `Cache-Control` para el archivo, se devuelve el valor de `Cache-Control` en el encabezado.
`Content-Disposition`	Devuelve el valor especificado para el encabezado `x-ms-content-disposition` y especifica cómo procesar la respuesta. El `Content-Disposition` campo de encabezado de respuesta transmite información adicional sobre cómo procesar la carga de respuesta y puede usarla para adjuntar metadatos adicionales. Por ejemplo, si se establece `attachment`en , `Content-Disposition` indica que el agente de usuario no debe mostrar la respuesta, pero debe mostrar una ventana Guardar como en su lugar.
`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`	Indica la versión del servicio 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-copy-completion-time:<datetime>`	Versión 2015-02-21 y posteriores. La hora de conclusión de la última operación de copiar archivo en la que este archivo era el archivo de destino. Este valor puede especificar la hora de un intento de copia completado, anulado o con errores. Este encabezado no aparece si una copia está pendiente, si este archivo nunca ha sido el destino en una operación Copiar archivo, o si este archivo se ha modificado después de una operación de copiar archivo finalizada mediante Establecer propiedades de archivo o Crear archivo.
`x-ms-copy-status-description: <error string>`	Versión 2015-02-21 y posteriores. Solo aparece cuando `x-ms-copy-status` se produce un error o está pendiente. Describe la causa de un error irrecuperable o no irrecuperable de la operación de copia. Este encabezado no aparece si una copia está pendiente, si este archivo nunca ha sido el destino en una operación Copiar archivo, o si este archivo se ha modificado después de una operación de copiar archivo finalizada mediante Establecer propiedades de archivo o Crear archivo.
`x-ms-copy-id: <id>`	Versión 2015-02-21 y posteriores. Identificador de cadena de la última operación de copiar archivo en la que este archivo era el archivo de destino. Este encabezado no aparece si este archivo nunca ha sido el destino en una operación copiar archivo , o si este archivo se ha modificado después de una operación de copiar archivo concluida mediante Establecer propiedades de archivo o Crear archivo.
`x-ms-copy-progress: <bytes copied/bytes total>`	Versión 2015-02-21 y posteriores. Contiene el número de bytes copiados y el total de bytes del origen en la última operación de copiar archivo en la que este archivo era el archivo de destino. Puede mostrar entre 0 y el número de `Content-Length` bytes copiados. Este encabezado no aparece si este archivo nunca ha sido el destino en una operación copiar archivo , o si este archivo se ha modificado después de una operación de copiar archivo concluida mediante Establecer propiedades de archivo o Crear archivo.
`x-ms-copy-source: url`	Versión 2015-02-21 y posteriores. Una dirección URL de hasta 2 KB caracteres que especifica el archivo de origen que se usó en la última operación de copiar archivo en la que este archivo era el archivo de destino. Este encabezado no aparece si este archivo nunca ha sido el destino en una operación copiar archivo , o si este archivo se ha modificado después de una operación de copiar archivo concluida mediante Establecer propiedades de archivo o Crear archivo.
`x-ms-copy-status: <pending ¦ success ¦ aborted ¦ failed>`	Versión 2015-02-21 y posteriores. Estado de la operación de copia identificada por `x-ms-copy-id`, con estos valores: - Éxito: Copia completada correctamente. - Pendiente: La copia está en curso. Compruebe `x-ms-copy-status-description` si los errores intermitentes y no irrecuperables impiden el progreso de la copia, pero no provocan errores. - Abortado: La copia finalizó anulando el archivo de copia. - Fallado: Error de copia. Para obtener información sobre los errores, vea `x-ms-copy-status-description`. Este encabezado no aparece si este archivo nunca ha sido el destino en una operación copiar archivo , o si este archivo se ha modificado después de una operación de copiar archivo concluida mediante Establecer propiedades de archivo o Crear archivo.
`x-ms-server-encrypted: true/false`	Versión 2017-04-17 y posteriores. El valor de este encabezado se establece `true` en si los datos de archivo y los metadatos de la aplicación se cifran completamente mediante el algoritmo especificado. El valor se establece `false` en si el archivo no está cifrado o si solo se cifran partes del archivo o los metadatos de la aplicación.
`x-ms-file-permission-key`	Versión 2019-02-02 y posteriores. Clave del permiso del archivo.
`x-ms-file-attributes`	Versión 2019-02-02 y posteriores. Atributos del sistema de archivos del archivo. Para obtener más información, consulte la lista de atributos disponibles.
`x-ms-file-creation-time`	Versión 2019-02-02 y posteriores. Valor de fecha y hora UTC que representa la propiedad de hora de creación de un archivo.
`x-ms-file-last-write-time`	Versión 2019-02-02 y posteriores. Valor de fecha y hora UTC que representa la última propiedad de hora de escritura del archivo.
`x-ms-file-change-time`	Versión 2019-02-02 y posteriores. Valor de fecha y hora UTC que representa la propiedad de hora de cambio del archivo.
`x-ms-file-file-id`	Versión 2019-02-02 y posteriores. Identificador de archivo del archivo.
`x-ms-file-parent-id`	Versión 2019-02-02 y posteriores. Identificador de archivo primario del archivo.
`x-ms-lease-duration:infinite`	Versión 2019-02-02 y posteriores. Cuando se alquila un archivo, especifica que la concesión es de duración infinita.
`x-ms-lease-state:<available;leased;broken>`	Versión 2019-02-02 y posteriores. Cuando se alquila un archivo, especifica el estado de concesión del archivo.
`x-ms-lease-status:<locked;unlocked>`	Versión 2019-02-02 y posteriores. Cuando se alquila un archivo, especifica el estado de concesión del archivo.
`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 está presente en la respuesta.

Response body