Cambiar nombre de archivo

La operación Rename File cambia el nombre de un archivo y, opcionalmente, puede establecer las propiedades del sistema para el archivo. Esta API está disponible en la versión 2021-04-10 y posteriores.

Disponibilidad del protocolo

Protocolo habilitado para recursos compartidos de archivos	Disponible
SMB
NFS

Pedir

Puede construir la solicitud Rename File de la siguiente manera. Se recomienda HTTPS.

Método	URI de solicitud	Versión HTTP
PONER	https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename	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.
myshare	Nombre del recurso compartido de archivos.
mydirectorypath	Opcional. Ruta de acceso al directorio de destino primario.
myfile	Nombre del archivo de destino.

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 el siguiente parámetro adicional en el URI de solicitud.

Parámetro	Descripción
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-file-rename-source:name	Obligatorio. URI completo del archivo cuyo nombre se va a cambiar.
x-ms-file-rename-replace-if-exists	Opcional. Si el archivo de destino ya existe, sobrescriba el archivo.
x-ms-file-rename-ignore-readonly	Opcional. Si el archivo de destino existe con el atributo readonly, sobrescriba el archivo. Si es true, x-ms-file-rename-replace-if-exists también debe ser true.
x-ms-content-Type	Opcional. Establece el tipo de contenido del archivo. Si esta propiedad no se especifica en la solicitud, la propiedad se conservará para el archivo.
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> }	Opcional si no se especifica x-ms-file-permission-key. Este permiso es el descriptor de seguridad del archivo especificado en la lenguaje de definición de descriptores de seguridad (SDDL) o (versión 2024-11-04 o posterior) en formato de descriptor de seguridad binario . Puede especificar el formato que se va a usar con el encabezado x-ms-file-permission-format. Puede usar este encabezado si el tamaño de los permisos es de 8 kibibytes (KiB) o menos. De lo contrario, puede usar x-ms-file-permission-key. Si se especifica, este permiso debe tener un propietario, grupo y lista de control de acceso discrecional. Puede pasar un valor de preserve si desea mantener un valor existente sin cambios. Tenga en cuenta que puede especificar x-ms-file-permission o x-ms-file-permission-key, no ambos.
x-ms-file-permission-format: { sddl ¦ binary }	Opcional. Versión 2024-11-04 o posterior. Especifica si el valor pasado en x-ms-file-permission está en SDDL o en formato binario. Si x-ms-file-permission-key se establece en preserve, este encabezado no debe establecerse. Si x-ms-file-permission-key se establece en cualquier otro valor que no sea preservey si no se establece este encabezado, se usa el valor predeterminado de sddl.
x-ms-file-permission-key	Opcional si no se especifica x-ms-file-permission. Clave del permiso que se va a establecer para el archivo. Puede crearlo mediante la API de Create-Permission. Tenga en cuenta que puede especificar x-ms-file-permission o x-ms-file-permission-key, no ambos.
x-ms-file-attributes	Opcional. Atributos del sistema de archivos que se van a establecer en el archivo. Consulte la lista de atributos disponibles . Puede pasar un valor de preserve si desea mantener un valor existente sin cambios. Si no especifica esta propiedad en la solicitud, la propiedad se conservará para el archivo.
x-ms-file-creation-time	Opcional. Propiedad de hora de creación UTC para un archivo. Puede pasar un valor de preserve si desea mantener un valor existente sin cambios. Si no especifica esta propiedad en la solicitud, la propiedad se conservará para el archivo.
x-ms-file-last-write-time	Opcional. La propiedad utc de última escritura de un archivo. Puede pasar un valor de preserve si desea mantener un valor existente sin cambios. Si no especifica esta propiedad en la solicitud, la propiedad se conservará para el archivo.
x-ms-source-lease-id:<ID>	Obligatorio si el archivo de origen tiene una concesión activa.
x-ms-destination-lease-id:<ID>	Obligatorio si el archivo de destino tiene una concesión activa.
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 Blob 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 adjuntos al archivo. Los nombres de metadatos deben cumplir las reglas de nomenclatura de los identificadores de C# .
x-ms-file-request-intent	Obligatorio si Authorization encabezado especifica un token de OAuth. El valor aceptable es backup. Este encabezado especifica que se debe conceder el Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action o Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action si se incluyen en la directiva de RBAC asignada a la identidad autorizada mediante el encabezado Authorization. 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, vea Asignar nombres y hacer referencia a recursos compartidos, directorios, archivos y metadatos.
x-ms-source-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 origen. Este encabezado solo debe especificarse si el origen de copia es un archivo de Azure. Este encabezado no se admite para ningún otro tipo de origen de copia. Para obtener más información, vea Asignar nombres y hacer referencia a recursos compartidos, directorios, archivos y metadatos.

Cuerpo de la solicitud

Ninguno.

Respuesta

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

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

Encabezado de respuesta	Descripción
ETag	Contiene un valor que representa la versión del archivo, entre comillas.
Last-Modified	Devuelve la fecha y hora en que se modificó por última vez el archivo. Para obtener más información, vea Representación de valores de fecha y hora en encabezados. Cualquier operación que modifique el directorio, 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 directorio.
x-ms-request-id	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-request-server-encrypted: true/false	El valor de este encabezado se establece en true si el contenido de la solicitud se cifra correctamente mediante el algoritmo especificado. De lo contrario, el valor se establece en false.
x-ms-file-permission-key	Clave del permiso del archivo.
x-ms-file-attributes	Atributos del sistema de archivos en el archivo. Consulte la lista de atributos disponibles .
x-ms-file-creation-time	Valor de fecha y hora UTC que representa la propiedad de hora de creación del archivo.
x-ms-file-last-write-time	Valor de fecha y hora UTC que representa la propiedad de hora de última escritura del archivo.
x-ms-file-change-time	Fecha y hora UTC que representa la propiedad de hora de cambio del archivo.
x-ms-file-file-id	Identificador de archivo del archivo.
x-ms-file-parent-id	Identificador de archivo primario 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 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, no estará presente en la respuesta.

Cuerpo de la respuesta

Ninguno.

Autorización

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

Atributos del sistema de archivos

Atributo	Atributo de archivo Win32	Definición
ReadOnly	FILE_ATTRIBUTE_READONLY	Un archivo que es de solo lectura. Las aplicaciones pueden leer el archivo, pero no pueden escribir en él ni eliminarlo.
Hidden	FILE_ATTRIBUTE_HIDDEN	El archivo está oculto. No se incluye en una lista de directorios normal.
System	FILE_ATTRIBUTE_SYSTEM	Un archivo del que el sistema operativo usa una parte de o usa exclusivamente.
None	FILE_ATTRIBUTE_NORMAL	Archivo que no tiene otros atributos establecidos. Este atributo solo es válido cuando se usa solo.
Archive	FILE_ATTRIBUTE_ARCHIVE	Un archivo que es un archivo de archivo. Las aplicaciones suelen usar este atributo para marcar los archivos de copia de seguridad o eliminación.
Temporary	FILE_ATTRIBUTE_TEMPORARY	Un archivo que se usa para el almacenamiento temporal.
Offline	FILE_ATTRIBUTE_OFFLINE	Los datos de un archivo no están disponibles inmediatamente. Este atributo del sistema de archivos se presenta principalmente para proporcionar compatibilidad con Windows. Azure Files no admite las opciones de almacenamiento sin conexión.
NotContentIndexed	FILE_ATTRIBUTE_NOT_CONTENT_INDEXED	El servicio de indexación de contenido no indexa el archivo.
NoScrubData	FILE_ATTRIBUTE_NO_SCRUB_DATA	El analizador de integridad de datos en segundo plano no debe leer el flujo de datos de usuario. Este atributo del sistema de archivos se presenta principalmente para proporcionar compatibilidad con Windows.

Observaciones

El destino no puede ser un directorio existente.

Si no especifica propiedades, se establecerá el comportamiento predeterminado de preserve o now.

Nota

Las propiedades de archivo anteriores son discretas de las propiedades del sistema de archivos disponibles para los clientes SMB. Los clientes SMB no pueden leer, escribir ni modificar estos valores de propiedad.

Rename File no se admite en una instantánea de recurso compartido, que es una copia de solo lectura de un recurso compartido. Si intenta realizar esta operación en una instantánea de recurso compartido, el servicio devuelve el estado de error 400 (valor de parámetro de consulta no válido).

Si el archivo tiene una concesión activa, el cliente debe especificar un identificador de concesión válido en la solicitud para cambiar el nombre del archivo. Si el cliente no especifica un identificador de concesión o especifica un identificador de concesión no válido, Azure Files 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, Azure Files también devuelve el código de estado 412 (error de condición previa).

Consulte también

Operaciones de en archivos