Ganti Nama Direktori

Operasi Rename Directory mengganti nama direktori, dan secara opsional dapat mengatur properti sistem untuk direktori. API ini tersedia dalam versi 2021-04-10 dan yang lebih baru.

Ketersediaan protokol

Mengaktifkan protokol berbagi file Tersedia
SMB Ya
NFS Tidak

Minta

Anda dapat membuat Rename Directory permintaan sebagai berikut. HTTPS disarankan.

Metode Meminta URI Versi HTTP
PUT https://myaccount.file.core.windows.net/myshare/mydirectorypath/mydirectory?restype=directory&comp=rename HTTP/1.1

Ganti komponen jalur yang ditunjukkan dalam URI permintaan dengan milik Anda sendiri, sebagai berikut:

Komponen jalur Deskripsi
myaccount Nama akun penyimpanan Anda.
myshare Nama berbagi file Anda.
mydirectorypath Opsional. Jalur ke direktori induk.
mydirectory Nama direktori target.

Untuk detail tentang pembatasan penamaan jalur, lihat Penamaan dan referensi berbagi, direktori, file, dan metadata.

Parameter URI

Anda dapat menentukan parameter tambahan berikut pada URI permintaan.

Parameter Deskripsi
timeout Opsional. Parameter timeout dinyatakan dalam hitung detik. Untuk informasi selengkapnya, lihat Mengatur batas waktu untuk operasi Azure Files.

Header permintaan

Tabel berikut ini menjelaskan header permintaan yang diperlukan dan opsional.

Meminta kop Deskripsi
Authorization Wajib diisi. Menentukan skema otorisasi, nama akun, dan tanda tangan. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage.
Date atau x-ms-date Wajib diisi. Menentukan Waktu Universal Terkoordinasi (UTC) untuk permintaan tersebut. Untuk informasi selengkapnya, lihat Mengotorisasi permintaan ke Azure Storage.
x-ms-version Diperlukan untuk semua permintaan yang diotorisasi. Menentukan versi operasi yang akan digunakan untuk permintaan ini. Untuk informasi selengkapnya, lihat Penerapan versi untuk layanan Azure Storage.
x-ms-file-rename-source:name Wajib diisi. URI penuh direktori yang akan diganti namanya.
x-ms-file-rename-ignore-readonly Opsional. Jika direktori tujuan ada dengan readonly atribut , timpa direktori.

Jika true, x-ms-file-rename-replace-if-exists juga harus benar.
x-ms-file-permission Opsional jika x-ms-file-permission-key tidak ditentukan. Izin ini adalah deskriptor keamanan untuk direktori yang ditentukan dalam Bahasa Definisi Deskriptor Keamanan (SDDL). Anda dapat menggunakan header ini jika ukuran izin adalah 8 kibibyte (KiB) atau kurang. Jika tidak, Anda dapat menggunakan x-ms-file-permission-key. Jika ditentukan, izin ini harus memiliki pemilik, grup, dan daftar kontrol akses diskresi. Anda dapat meneruskan nilai preserve jika Anda ingin mempertahankan nilai yang ada tidak berubah.

Perhatikan bahwa Anda dapat menentukan atau x-ms-file-permissionx-ms-file-permission-key, bukan keduanya.
x-ms-file-permission-key Opsional jika x-ms-file-permission tidak ditentukan. Kunci izin yang akan diatur untuk direktori. Anda dapat membuat ini dengan menggunakan Create-Permission API.

Perhatikan bahwa Anda dapat menentukan atau x-ms-file-permissionx-ms-file-permission-key, bukan keduanya.
x-ms-file-attributes Pilihan. Atribut sistem file yang akan diatur pada direktori. Lihat daftar atribut yang tersedia. Anda dapat meneruskan nilai preserve jika Anda ingin mempertahankan nilai yang ada tidak berubah. Jika properti ini tidak ditentukan pada permintaan, properti akan dipertahankan.
x-ms-file-creation-time Pilihan. Properti waktu pembuatan UTC untuk direktori. Anda dapat meneruskan nilai preserve jika Anda ingin mempertahankan nilai yang ada tidak berubah. Jika properti ini tidak ditentukan pada permintaan, properti akan dipertahankan.
x-ms-file-last-write-time Pilihan. Properti tulis terakhir UTC untuk direktori. Anda dapat meneruskan nilai preserve jika Anda ingin mempertahankan nilai yang ada tidak berubah. Jika properti ini tidak ditentukan pada permintaan, properti akan dipertahankan.
x-ms-destination-lease-id:<ID> Diperlukan jika file tujuan memiliki sewa aktif.
x-ms-client-request-id Pilihan. Menyediakan nilai buram yang dihasilkan klien dengan batas karakter 1 KiB yang dicatat dalam log saat pengelogan dikonfigurasi. Kami sangat menyarankan Anda menggunakan header ini untuk menghubungkan aktivitas sisi klien dengan permintaan yang diterima server. Untuk informasi selengkapnya, lihat Memantau Azure Blob Storage.
x-ms-meta-name:value Pilihan. Mengatur pasangan nama-nilai untuk direktori.

Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang dilampirkan ke direktori.

Nama metadata harus mematuhi aturan penamaan untuk pengidentifikasi C#. Jika properti ini tidak ditentukan pada permintaan, properti akan dipertahankan.
x-ms-file-request-intent Diperlukan jika Authorization header menentukan token OAuth. Nilai yang dapat diterima adalah backup. Header ini menentukan bahwa Microsoft.Storage/storageAccounts/fileServices/readFileBackupSemantics/action atau Microsoft.Storage/storageAccounts/fileServices/writeFileBackupSemantics/action harus diberikan jika disertakan dalam kebijakan RBAC yang ditetapkan ke identitas yang diotorisasi menggunakan Authorization header . Tersedia untuk versi 2022-11-02 dan yang lebih baru.
x-ms-allow-trailing-dot: { <Boolean> } Opsional. Versi 2022-11-02 dan yang lebih baru. Nilai Boolean menentukan apakah titik berikutnya yang ada di url permintaan harus dipangkas atau tidak. Untuk informasi selengkapnya, lihat Penamaan dan referensi berbagi, direktori, file, dan metadata.
x-ms-source-allow-trailing-dot: { <Boolean> } Pilihan. Versi 2022-11-02 dan yang lebih baru. Nilai Boolean menentukan apakah titik berikutnya yang ada di url sumber harus dipangkas atau tidak. Header ini harus ditentukan hanya jika sumber salin adalah berbagi file Azure. Header ini tidak didukung untuk jenis sumber salinan lainnya. Untuk informasi selengkapnya, lihat Memberi nama dan mereferensikan berbagi, direktori, file, dan metadata.

Isi permintaan

Tidak ada.

Respons

Respons mencakup kode status HTTP dan sekumpulan header respons.

Kode status

Operasi yang berhasil mengembalikan kode status 200 (OK). Untuk informasi tentang kode status, lihat Status dan kode kesalahan.

Header respons

Respons untuk operasi ini mencakup header berikut. Respons juga dapat mencakup header HTTP standar tambahan. Semua header standar sesuai dengan spesifikasi protokol HTTP/1.1.

Header respons Deskripsi
ETag Berisi nilai yang mewakili versi file, dalam tanda kutip.
Last-Modified Mengembalikan tanggal dan waktu file terakhir diubah. Untuk informasi selengkapnya, lihat Representasi nilai tanggal-waktu di header. Setiap operasi yang memodifikasi direktori, atau propertinya, memperbarui waktu terakhir diubah. Operasi pada file tidak memengaruhi waktu terakhir direktori yang dimodifikasi.
x-ms-request-id Secara unik mengidentifikasi permintaan yang dibuat dan dapat digunakan untuk memecahkan masalah permintaan. Untuk informasi selengkapnya, lihat Pemecahan masalah operasi API.
x-ms-version Menunjukkan versi Azure Files yang digunakan untuk menjalankan permintaan.
Date atau x-ms-date Nilai tanggal/waktu UTC yang menunjukkan waktu di mana respons dimulai. Layanan menghasilkan nilai ini.
x-ms-request-server-encrypted: true/false Nilai header ini diatur ke true jika konten permintaan berhasil dienkripsi dengan menggunakan algoritma yang ditentukan. Jika tidak, nilai diatur ke false.
x-ms-file-permission-key Kunci izin file.
x-ms-file-attributes Atribut sistem file pada file. Lihat daftar atribut yang tersedia.
x-ms-file-creation-time Nilai tanggal/waktu UTC yang mewakili properti waktu pembuatan untuk file.
x-ms-file-last-write-time Nilai tanggal/waktu UTC yang mewakili properti waktu tulis terakhir untuk file.
x-ms-file-change-time Tanggal/waktu UTC yang mewakili properti waktu perubahan untuk file.
x-ms-file-file-id ID file file.
x-ms-file-parent-id ID file induk file.
x-ms-client-request-id Dapat digunakan untuk memecahkan masalah permintaan dan respons yang sesuai. Nilai header ini sama dengan nilai x-ms-client-request-id header, jika ada dalam permintaan. Nilainya paling banyak 1.024 karakter ASCII yang terlihat. x-ms-client-request-id Jika header tidak ada dalam permintaan, header tidak akan ada dalam respons.

Isi Respons

Tidak ada.

Authorization

Hanya pemilik akun yang dapat memanggil operasi ini.

Atribut sistem file

Atribut Atribut file Win32 Definisi
ReadOnly FILE_ATTRIBUTE_READONLY Direktori yang bersifat baca-saja.
Hidden FILE_ATTRIBUTE_HIDDEN Direktori disembunyikan. Ini tidak termasuk dalam daftar direktori biasa.
System FILE_ATTRIBUTE_SYSTEM Direktori yang digunakan sistem operasi, atau digunakan secara eksklusif.
None FILE_ATTRIBUTE_NORMAL Direktori yang tidak memiliki atribut lain yang ditetapkan. Atribut ini hanya valid jika digunakan sendiri.
Directory FILE_ATTRIBUTE_DIRECTORY Handel yang mengidentifikasi direktori.
Archive FILE_ATTRIBUTE_ARCHIVE Direktori yang merupakan direktori arsip. Aplikasi biasanya menggunakan atribut ini untuk menandai file untuk pencadangan atau penghapusan.
Offline FILE_ATTRIBUTE_OFFLINE Data direktori tidak segera tersedia. Atribut sistem file ini disajikan terutama untuk memberikan kompatibilitas dengan Windows. Azure Files tidak mendukung opsi penyimpanan offline.
NotContentIndexed FILE_ATTRIBUTE_NOT_CONTENT_INDEXED Direktori tidak akan diindeks oleh layanan pengindeksan konten.
NoScrubData FILE_ATTRIBUTE_NO_SCRUB_DATA Aliran data pengguna tidak boleh dibaca oleh pemindai integritas data latar belakang. Atribut sistem file ini disajikan terutama untuk memberikan kompatibilitas dengan Windows.

Keterangan

Jika target adalah direktori, maka direktori tidak boleh ada.

Rename Directory tidak didukung pada salinan bayangan berbagi, yang merupakan salinan berbagi baca-saja. Jika Anda mencoba melakukan operasi ini pada salinan bayangan berbagi, layanan mengembalikan status kesalahan 400 (Nilai Parameter Kueri Tidak Valid).

Jika Anda tidak menentukan properti, perilaku preserve default atau now akan diatur.

Jika direktori memiliki sewa aktif, klien harus menentukan ID sewa yang valid pada permintaan untuk mengganti nama direktori. Jika klien tidak menentukan ID sewa, atau menentukan ID sewa yang tidak valid, Azure Files mengembalikan kode status 412 (Prasyarat Gagal). Jika klien menentukan ID sewa, tetapi direktori tidak memiliki sewa aktif, Azure Files juga mengembalikan kode status 412 (Prasyarat Gagal).

Lihat juga

Operasi pada direktori