重新命名檔案

發行項
05/01/2024

此 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 中的路徑元件取代為您自己的路徑元件，如下所示：

路徑元件	Description
`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`	必要。要重新命名之檔案的完整 URI。
`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 kibibytes (KiB) 或更少，您可以使用此標頭。否則，您可以使用 `x-ms-file-permission-key`。如果指定，此許可權必須具有擁有者、群組和任意訪問控制清單。如果您想要保留現有的值，可以傳遞的值 `preserve` 。請注意，您可以指定 `x-ms-file-permission` 或， `x-ms-file-permission-key`而不是兩者。
`x-ms-file-permission-key`	如果未指定， `x-ms-file-permission` 則為選擇性。要為檔案設定之許可權的索引鍵。您可以使用 API 來 `Create-Permission` 建立此專案。請注意，您可以指定 `x-ms-file-permission` 或， `x-ms-file-permission-key`而不是兩者。
`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 kibibyte (KiB) 字元限制。強烈建議您使用此標頭，將用戶端活動與伺服器接收的要求相互關聯。如需詳細資訊，請參閱監視 Azure Blob 儲存體。
`x-ms-meta-name:value`	選擇性。設定檔案的名稱/值組。每次呼叫這項作業都會取代附加至檔案的所有現有中繼資料。元數據名稱必須遵守 C# 識別碼的命名規則。
`x-ms-file-request-intent`	如果 `Authorization` 標頭指定 OAuth 令牌，則為必要專案。可接受的值為 `backup`。此標頭會`Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action`指定，如果在指派給使用 `Authorization` 標頭授權的身分識別的 RBAC 原則中包含，則應該授與或 `Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action` 。適用於 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 (OK)。如需狀態代碼的相關信息，請參閱狀態和錯誤碼。

回應標頭

這項作業的回應包括下列標頭。回應也可以包含額外的標準 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`	檔案的檔案識別碼。
`x-ms-file-parent-id`	檔案的父檔案標識碼。
`x-ms-client-request-id`	可用來針對要求和對應的回應進行疑難解答。如果此標頭存在於要求中，則此標頭的值等於標頭的值 `x-ms-client-request-id` 。此值最多為 1,024 個可見的 ASCII 字元。 `x-ms-client-request-id`如果要求中沒有標頭，它就不會出現在回應中。

回應本文

無。

授權

只有帳戶擁有者可以呼叫這項作業。

檔案系統屬性

屬性	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 (無效的查詢參數值) 。

如果檔案有作用中的租用，客戶端必須在要求上指定有效的租用標識碼，才能重新命名檔案。如果用戶端未指定租用標識碼，或指定無效的租用標識碼，Azure 檔案儲存體傳回狀態代碼 412 (前置條件失敗) 。如果用戶端指定租用標識碼，但檔案沒有作用中的租用，Azure 檔案儲存體也會傳回狀態代碼 412 (前置條件失敗) 。

另請參閱

檔案上的作業