Set File Metadata
La Set File Metadata operación establece metadatos definidos por el usuario para el archivo especificado.
Disponibilidad del protocolo
| Protocolo de recurso compartido de archivos habilitado | Disponible |
|---|---|
| SMB |
|
| NFS |
|
Solicitud
Puede construir la solicitud de la Set File Metadata siguiente manera. Se recomienda usar HTTPS.
| Método | URI de solicitud | Versión de HTTP |
|---|---|---|
PUT |
https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=metadata |
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
Puede especificar los siguientes parámetros adicionales en el URI de solicitud:
| Parámetro | Descripción |
|---|---|
timeout |
Opcional. El parámetro de tiempo de espera se expresa en segundos. Para obtener más información, consulte Establecimiento de tiempos de espera para las operaciones del servicio de archivos. |
Encabezados de solicitud
| Encabezado de solicitud | Descripción |
|---|---|
Authorization |
Necesario. Especifica el esquema de autorización, el nombre de 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 |
Necesario 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-meta-name:value |
Opcional. Establece un par nombre-valor para el archivo. Cada llamada a esta operación reemplaza todos los metadatos existentes adjuntados al archivo. Para quitar todos los metadatos del archivo, llame a esta operación sin encabezados de metadatos. Los nombres de metadatos deben cumplir las reglas de nomenclatura de los identificadores de C#. |
x-ms-lease-id:<ID> |
Requerido si el archivo tiene una concesión activa. Disponible para la versión 2019-02-02 y posteriores. |
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, consulte Supervisión de Azure Files. |
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 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 información sobre los códigos de estado, consulte Códigos de estado y 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 |
|---|---|
ETag |
Contiene un valor que representa la versión del archivo. 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 |
Indica la versión del servicio File que se usó para ejecutar la solicitud. |
Date o x-ms-date |
Valor de fecha y hora UTC generado por el servicio, que indica la hora en que se inició la respuesta. |
x-ms-request-server-encrypted: true/false |
Versión 2017-04-17 y posteriores. El valor de este encabezado se establece true en si el contenido de la solicitud se cifra correctamente mediante el algoritmo especificado. De lo contrario, el valor se establece en false. |
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.
Authorization
Solo el propietario de la cuenta puede llamar a esta operación.
Observaciones
Set File Metadata no se admite en una instantánea de recurso compartido, que es una copia de solo lectura de un recurso compartido. Se produce un error al intentar realizar esta operación en una instantánea de recurso compartido con 400 (InvalidQueryParameterValue)
Si el archivo tiene una concesión activa, el cliente debe especificar un identificador de concesión válido en la solicitud para escribir metadatos en el archivo. Si el cliente no especifica un identificador de concesión o especifica un identificador de concesión no válido, el servicio de archivos devuelve el código de estado 412 (error de condición previa). Si el cliente especifica un identificador de concesión, pero el archivo no tiene una concesión activa, el servicio archivo también devuelve el código de estado 412 (error de condición previa).