重新命名目錄
Rename Directory 作業會重新命名目錄，而且可以選擇性地設定目錄的系統屬性。 此 API 適用於 2021-04-10 版和更新版本。
通訊協定可用性
| 已啟用檔案共享通訊協定 | 可用 |
|---|---|
| SMB |
|
| NFS |
|
請求
您可以建構 Rename Directory 要求，如下所示。 建議使用 HTTPS。
| 方法 | 要求 URI | HTTP 版本 |
|---|---|---|
| 放 | https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename |
HTTP/1.1 |
以您自己的方式取代要求 URI 中顯示的路徑元件，如下所示：
| 路徑元件 | 描述 |
|---|---|
myaccount |
記憶體帳戶的名稱。 |
myshare |
檔案共享的名稱。 |
mydirectorypath |
自選。 父目錄的路徑。 |
mydirectory |
目標目錄的名稱。 |
如需路徑命名限制的詳細資訊，請參閱 命名和參考共用、目錄、檔案和元資料。
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-ignore-readonly |
自選。 如果目的地目錄存在具有 readonly 屬性，請覆寫目錄。如果為 true，則 x-ms-file-rename-replace-if-exists 也必須為 true。 |
x-ms-file-permission: { preserve ¦ <SDDL> ¦ <binary> } |
如果未指定 x-ms-file-permission-key，則為選擇性。 此許可權是 x-ms-file-permission-format 標頭搭配使用的格式。 如果許可權大小是 8 kibibytes （KiB） 或更少，您可以使用此標頭。 否則，您可以使用 x-ms-file-permission-key。 如果指定，此權限必須擁有擁有者、群組和 選擇性存取控制清單，。 如果您想要維持現有值不變，可以傳遞 preserve 的值。請注意，您可以指定 x-ms-file-permission 或 x-ms-file-permission-key，而不是兩者。 |
x-ms-file-permission-format: { sddl ¦ binary } |
自選。 版本 2024-11-04 或更新版本。 指定傳入 x-ms-file-permission 的值是否為 SDDL 或二進位格式。 如果 x-ms-file-permission-key 設定為 preserve，則不應該設定此標頭。 如果 x-ms-file-permission-key 設定為 preserve以外的任何其他值，而且如果未設定此標頭，則會使用 sddl 的預設值。 |
x-ms-file-permission-key |
如果未指定 x-ms-file-permission，則為選擇性。 要為目錄設定之許可權的索引鍵。 您可以使用 Create-Permission API 來建立此專案。請注意，您可以指定 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-destination-lease-id:<ID> |
如果目的地檔案具有使用中租用，則為必要專案。 |
x-ms-client-request-id |
自選。 提供客戶端產生的不透明值，其中包含設定記錄時記錄在記錄中記錄的 1 KiB 字元限制。 強烈建議您使用此標頭，將用戶端活動與伺服器接收的要求相互關聯。 如需詳細資訊，請參閱 監視 Azure Blob 記憶體。 |
x-ms-meta-name:value |
自選。 設定目錄的名稱/值組。 每次呼叫此作業時，都會取代附加至目錄的所有現有元數據。 中繼資料名稱必須遵循 C# 識別子的命名規則，。 如果未在要求上指定這個屬性，則會保留屬性。 |
x-ms-file-request-intent |
如果 Authorization 標頭指定 OAuth 令牌，則為必要項。 可接受的值為 backup。 如果 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action 或 Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action 包含在指派給使用 Authorization 標頭授權的身分識別中，則此標頭指定應授與 Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action 或 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 （確定）。 如您需狀態代碼的相關資訊，請參閱 狀態和錯誤碼。
回應標頭
此作業的回應包含下列標頭。 回應也可以包含額外的標準 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 | 未設定其他屬性的目錄。 此屬性只有在單獨使用時才有效。 |
Directory |
FILE_ATTRIBUTE_DIRECTORY | 識別目錄的句柄。 |
Archive |
FILE_ATTRIBUTE_ARCHIVE | 為封存目錄的目錄。 應用程式通常會使用此屬性來標記檔案以進行備份或移除。 |
Offline |
FILE_ATTRIBUTE_OFFLINE | 目錄的數據無法立即使用。 此文件系統屬性主要是為了提供與 Windows 的相容性。 Azure 檔案記憶體不支援離線記憶體選項。 |
NotContentIndexed |
FILE_ATTRIBUTE_NOT_CONTENT_INDEXED | 目錄不會由內容索引服務編製索引。 |
NoScrubData |
FILE_ATTRIBUTE_NO_SCRUB_DATA | 背景數據完整性掃描器不會讀取用戶數據流。 此文件系統屬性主要是為了提供與 Windows 的相容性。 |
言論
如果目標為目錄，則目錄不得存在。
共用快照集不支援 Rename Directory，這是共用的唯讀複本。 如果您嘗試在共用快照集上執行這項作業，服務會傳回錯誤狀態 400 （無效的查詢參數值）。
如果您未指定屬性，則會設定 preserve 或 now 的預設行為。
如果目錄具有作用中租用，客戶端必須在要求上指定有效的租用標識碼，才能重新命名目錄。 如果用戶端未指定租用標識符，或指定無效的租用標識符，Azure 檔案服務會傳回狀態代碼 412（前置條件失敗）。 如果用戶端指定租用標識碼，但目錄沒有使用中的租用，Azure 檔案服務也會傳回狀態代碼 412（前置條件失敗）。
另請參閱
目錄上的 作業