你当前正在访问 Microsoft Azure Global Edition 技术文档网站。如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

重命名文件

项目
07/26/2023

该 Rename File 操作将重命名文件，并可以选择为文件设置系统属性。此 API 在版本 2021-04-10 及更高版本中可用。

协议可用性

已启用文件共享协议	可用
SMB
NFS

请求

可以按如下所示构造 Rename File 请求。建议使用 HTTPS。

方法	请求 URI	HTTP 版本
PUT	`https://myaccount.file.core.windows.net/myshare/mydirectorypath/myfile?comp=rename`	HTTP/1.1

将请求 URI 中所示的路径组件替换为你自己的组件，如下所示：

路径组件	说明
`myaccount`	存储帐户的名称。
`myshare`	文件共享的名称。
`mydirectorypath`	可选。父目标目录的路径。
`myfile`	目标文件的名称。

有关路径命名限制的详细信息，请参阅命名和引用共享、目录、文件和元数据。

URI 参数

可以在请求 URI 上指定以下附加参数。

参数	说明
`timeout`	可选。 `timeout` 参数以秒表示。有关详细信息，请参阅设置Azure 文件存储操作的超时。

请求标头

下表介绍必需的和可选的请求标头。

请求标头	说明
`Authorization`	必需。指定授权方案、帐户名称和签名。有关详细信息，请参阅授权对 Azure 存储的请求。
`Date` 或 `x-ms-date`	必需。指定请求的协调世界时 (UTC)。有关详细信息，请参阅授权对 Azure 存储的请求。
`x-ms-version`	对于所有已授权的请求是必需的。指定用于此请求的操作的版本。有关详细信息，请参阅 Azure 存储服务的版本控制。
`x-ms-file-rename-source:name`	必需。要重命名的文件的名称。
`x-ms-file-rename-replace-if-exists`	可选。如果目标文件已存在，请覆盖该文件。
`x-ms-file-rename-ignore-readonly`	可选。如果目标文件与属性一起 `readonly` 存在，请覆盖该文件。如果为 true， `x-ms-file-rename-replace-if-exists` 则还必须为 true。
`x-ms-content-Type`	可选。设置文件的内容类型。如果未在请求中指定此属性，则将为文件保留该属性。
`x-ms-file-permission`	如果未指定，则 `x-ms-file-permission-key` 为可选。此权限是安全描述符定义语言 (SDDL) 中指定的文件的安全描述符。如果权限大小为 8 kiB () 或更小，则可以使用此标头。否则，可以使用 `x-ms-file-permission-key`。如果指定，此权限必须具有所有者、组和可自由访问控制列表。如果要使现有值保持不变， `preserve` 可以传递值。请注意，可以指定或 `x-ms-file-permission-key`，而不是同时指定`x-ms-file-permission`两者。
`x-ms-file-permission-key`	如果未指定，则 `x-ms-file-permission` 为可选。要为文件设置的权限的键。可以使用 API 创建此 `Create-Permission` API。请注意，可以指定或 `x-ms-file-permission-key`，而不是同时指定`x-ms-file-permission`两者。
`x-ms-file-attributes`	可选。要对文件设置的文件系统属性。请参阅可用属性列表。如果要使现有值保持不变， `preserve` 可以传递值。如果未在请求中指定此属性，则将保留文件的属性。
`x-ms-file-creation-time`	可选。文件的 UTC 创建时间属性。如果要使现有值保持不变， `preserve` 可以传递值。如果未在请求中指定此属性，则将保留文件的属性。
`x-ms-file-last-write-time`	可选。文件的 UTC 上次写入属性。如果要使现有值保持不变， `preserve` 可以传递值。如果未在请求中指定此属性，则将保留文件的属性。
`x-ms-source-lease-id:<ID>`	如果源文件具有活动租约，则是必需的。
`x-ms-destination-lease-id:<ID>`	如果目标文件具有活动租约，则为必需。
`x-ms-client-request-id`	可选。提供客户端生成的不透明值，其中包含 1-kiB (KiB) 配置日志记录时记录在日志中的字符限制。强烈建议使用此标头将客户端活动与服务器接收的请求相关联。有关详细信息，请参阅监视Azure Blob 存储。
`x-ms-meta-name:value`	可选。为文件设置名称-值对。每次调用此操作都会替换附加到该文件的所有现有元数据。元数据名称必须遵循 C# 标识符的命名规则。
`x-ms-file-request-intent`	如果 `Authorization` 标头指定 OAuth 令牌，则为必需。可接受的值为 `backup`。此标头指定`Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/actionMicrosoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action`，如果或包含在分配给使用标头授权的标识的 RBAC 策略中，则应授予或`Authorization`。适用于版本 2022-11-02 及更高版本。
`x-ms-allow-trailing-dot: { <Boolean> }`	可选。版本 2022-11-02 及更高版本。布尔值指定是否应剪裁请求 URL 中存在的尾随点。有关详细信息，请参阅命名和引用共享、目录、文件和元数据。
`x-ms-source-allow-trailing-dot: { <Boolean> }`	可选。版本 2022-11-02 及更高版本。布尔值指定是否应剪裁源 URL 中存在的尾随点。仅当复制源是 Azure 文件时，才应指定此标头。任何其他复制源类型都不支持此标头。有关详细信息，请参阅命名和引用共享、目录、文件和元数据。

请求正文

无。

响应

响应包括 HTTP 状态代码和一组响应标头。

状态代码

此操作成功后返回状态代码 200（正常）。有关状态代码的信息，请参阅状态和错误代码。

响应头

此操作的响应包括以下标头。响应还可以包含其他标准 HTTP 标头。所有标准标头都符合 HTTP/1.1 协议规范。

响应标头	说明
`ETag`	包含一个值，该值以引号表示文件的版本。
`Last-Modified`	返回上次修改文件的日期和时间。有关详细信息，请参阅标头中的日期时间值的表示形式。修改目录或其属性的任何操作将更新上次修改时间。对文件执行的操作不会影响目录的上次修改时间。
`x-ms-request-id`	唯一标识发出的请求，可用于对请求进行故障排除。有关详细信息，请参阅 API 操作故障排除。
`x-ms-version`	指示用于运行请求Azure 文件存储的版本。
`Date` 或 `x-ms-date`	指示启动响应的时间的 UTC 日期/时间值。服务生成此值。
`x-ms-request-server-encrypted: true/false`	如果使用指定的算法成功加密请求的内容，则此标头的值设置为 `true` 。否则，该值将设置为 `false`。
`x-ms-file-permission-key`	文件权限的键。
`x-ms-file-attributes`	文件上的文件系统属性。请参阅可用属性的列表。
`x-ms-file-creation-time`	表示文件的创建时间属性的 UTC 日期/时间值。
`x-ms-file-last-write-time`	表示文件的上次写入时间属性的 UTC 日期/时间值。
`x-ms-file-change-time`	表示文件的更改时间属性的 UTC 日期/时间。
`x-ms-file-file-id`	文件的文件 ID。
`x-ms-file-parent-id`	文件的父文件 ID。
`x-ms-client-request-id`	可用于对请求和相应的响应进行故障排除。如果请求中存在，则此标头的值等于标头的值 `x-ms-client-request-id` 。该值最多为 1，024 个可见 ASCII 字符。 `x-ms-client-request-id`如果请求中不存在标头，则响应中不会显示该标头。

响应正文

无。

授权

只有帐户所有者才能调用此操作。

文件系统属性

Attribute	Win32 文件属性	定义
`ReadOnly`	FILE_ATTRIBUTE_READONLY	只读文件。应用程序可以读取文件，但不能写入或删除它。
`Hidden`	FILE_ATTRIBUTE_HIDDEN	文件被隐藏。它不包括在普通目录列表中。
`System`	FILE_ATTRIBUTE_SYSTEM	操作系统使用其中的一部分或独占使用的文件。
`None`	FILE_ATTRIBUTE_NORMAL	未设置其他属性的文件。此属性仅在单独使用时有效。
`Archive`	FILE_ATTRIBUTE_ARCHIVE	作为存档文件的文件。应用程序通常使用此属性来标记要备份或删除的文件。
`Temporary`	FILE_ATTRIBUTE_TEMPORARY	用于临时存储的文件。
`Offline`	FILE_ATTRIBUTE_OFFLINE	文件的数据不会立即可用。此文件系统属性主要用于提供与 Windows 的兼容性。 Azure 文件存储不支持脱机存储选项。
`NotContentIndexed`	FILE_ATTRIBUTE_NOT_CONTENT_INDEXED	内容索引服务不会为文件编制索引。
`NoScrubData`	FILE_ATTRIBUTE_NO_SCRUB_DATA	后台数据完整性扫描程序不会读取用户数据流。此文件系统属性主要用于提供与 Windows 的兼容性。

注解

目标不能是现有目录。

如果未指定属性，则将设置或 now 的默认行为preserve。

注意

上述文件属性与 SMB 客户端可用的文件系统属性是分开的。 SMB 客户端无法读取、写入或修改这些属性值。

Rename File共享快照（共享的只读副本）上不受支持。如果尝试对共享快照执行此操作，服务将返回错误状态 400 (查询参数值无效) 。

如果文件具有活动租约，则客户端必须在请求中指定有效的租约 ID，以便重命名该文件。如果客户端未指定租约 ID，或指定无效的租约 ID，Azure 文件存储返回状态代码 412 (前置条件失败) 。如果客户端指定租约 ID，但文件没有活动的租约，Azure 文件存储还会返回状态代码 412 (前置条件失败) 。

另请参阅

对文件执行的操作