Path - Update
Tambahkan Data | Menghapus Data | Atur Properti | Mengatur Access Control
Mengunggah data untuk ditambahkan ke file, menghapus (menulis) data yang sebelumnya diunggah ke file, mengatur properti untuk file atau direktori, atau mengatur kontrol akses untuk file atau direktori. Data hanya dapat ditambahkan ke file. Penulisan bersamaan ke file yang sama menggunakan beberapa klien tidak didukung. Operasi ini mendukung permintaan HTTP kondisional. Untuk informasi selengkapnya, lihat Menentukan Header Kondisional untuk Operasi Blob Service.
PATCH https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}
PATCH https://{accountName}.{dnsSuffix}/{filesystem}/{path}?action={action}&position={position}&retainUncommittedData={retainUncommittedData}&close={close}&mode={mode}&maxRecords={maxRecords}&forceFlag={forceFlag}&continuation={continuation}&flush={flush}&timeout={timeout}
Parameter URI
Nama | Dalam | Diperlukan | Jenis | Deskripsi |
---|---|---|---|---|
account
|
path | True |
string |
Nama akun Azure Storage. |
dns
|
path | True |
string |
Akhiran DNS untuk titik akhir Azure Data Lake Storage. |
filesystem
|
path | True |
string |
Pengidentifikasi sistem file. Pola regex: |
path
|
path | True |
string |
Jalur file atau direktori. |
action
|
query | True |
Tindakan harus "menambahkan" untuk mengunggah data yang akan ditambahkan ke file, "flush" untuk membersihkan data yang sebelumnya diunggah ke file, "setProperties" untuk mengatur properti file atau direktori, atau "setAccessControl" untuk mengatur pemilik, grup, izin, atau daftar kontrol akses untuk file atau direktori, atau "setAccessControlRecursive" untuk mengatur daftar kontrol akses untuk direktori secara rekursif. Perhatikan bahwa Namespace Hierarkis harus diaktifkan untuk akun agar dapat menggunakan kontrol akses. Perhatikan juga bahwa daftar Access Control (ACL) menyertakan izin untuk pemilik, grup pemilik, dan lainnya, sehingga header permintaan x-ms-permissions dan x-ms-acl saling eksklusif. |
|
close
|
query |
boolean |
Peristiwa Azure Storage memungkinkan aplikasi menerima pemberitahuan saat file berubah. Saat Peristiwa Azure Storage diaktifkan, peristiwa perubahan file akan dimunculkan. Kejadian ini memiliki properti yang menunjukkan apakah ini adalah perubahan akhir untuk membedakan perbedaan antara flush perantara ke aliran file dan penutupan akhir aliran file. Parameter kueri penutupan hanya valid ketika tindakan "memerah" dan pemberitahuan perubahan diaktifkan. Jika nilai penutupan "true" dan operasi flush berhasil diselesaikan, layanan akan menaikkan pemberitahuan perubahan file dengan properti yang menunjukkan bahwa ini adalah pembaruan akhir (aliran file telah ditutup). Jika "false" pemberitahuan perubahan dimunculkan yang menunjukkan file telah berubah. Defaultnya adalah false (salah). Parameter kueri ini diatur ke true oleh driver Hadoop ABFS untuk menunjukkan bahwa aliran file telah ditutup." |
|
continuation
|
query |
string |
Opsional dan valid hanya untuk operasi "setAccessControlRecursive". Jumlah jalur yang diproses dengan setiap pemanggilan terbatas. Jika jumlah jalur yang akan diproses melebihi batas ini, token kelanjutan dikembalikan dalam header respons x-ms-continuation. Ketika token kelanjutan dikembalikan dalam respons, token tersebut harus dikodekan persen dan ditentukan dalam pemanggilan operasi setAccessControlRecursive berikutnya. |
|
flush
|
query |
boolean |
Hanya berlaku untuk panggilan tambahan. Parameter ini memungkinkan penelepon untuk membersihkan selama panggilan penampan. Nilai default adalah "false" , jika "true" data akan dihapus dengan panggilan penampan. Perhatikan bahwa saat menggunakan flush=true, header berikut tidak didukung - "x-ms-cache-control", "x-ms-content-encoding", "x-ms-content-type", "x-ms-content-language", "x-ms-content-md5", "x-ms-content-disposition". Untuk mengatur header ini selama flush, gunakan action=flush |
|
force
|
query |
boolean |
Opsional dan valid hanya untuk operasi "setAccessControlRecursive". Jika ini adalah operasi "false" akan berakhir dengan cepat saat mengalami kesalahan pengguna (4XX). Jika "true" api akan mengabaikan kesalahan pengguna dan melanjutkan operasi pada sub-entitas direktori lainnya. Status terperinci kesalahan pengguna akan dikembalikan dalam respons untuk salah satu skenario. Token kelanjutan hanya akan dikembalikan ketika forceFlag "true" jika terjadi kesalahan pengguna. Nilai default untuk forceFlag adalah false. |
|
max
|
query |
integer int32 |
Opsional dan valid hanya untuk operasi "setAccessControlRecursive". Ini menentukan jumlah maksimum file atau direktori tempat perubahan acl akan diterapkan. Jika dihilangkan atau lebih besar dari 2.000, permintaan akan memproses hingga 2.000 item |
|
mode
|
query |
string |
Pilihan. Valid dan diperlukan untuk operasi "setAccessControlRecursive". Mode "set" mengatur hak kontrol akses POSIX pada file dan direktori, "modifikasi" memodifikasi satu atau beberapa hak kontrol akses POSIX yang sudah ada sebelumnya pada file dan direktori, "hapus" menghapus satu atau beberapa hak kontrol akses POSIX yang ada sebelumnya pada file dan direktori |
|
position
|
query |
integer int64 |
Parameter ini memungkinkan pemanggil untuk mengunggah data secara paralel dan mengontrol urutan penambahannya ke file. Diperlukan saat mengunggah data untuk ditambahkan ke file dan saat membersihkan data yang diunggah sebelumnya ke file. Nilai harus posisi di mana data akan ditambahkan. Data yang diunggah tidak segera dihapus, atau ditulis, ke file. Untuk membersihkan, data yang diunggah sebelumnya harus bersebelahan, parameter posisi harus ditentukan dan sama dengan panjang file setelah semua data ditulis, dan tidak boleh ada badan entitas permintaan yang disertakan dengan permintaan. |
|
retain
|
query |
boolean |
Hanya berlaku untuk operasi flush. Jika "true", data yang tidak dikomit dipertahankan setelah operasi flush selesai; jika tidak, data yang tidak dikomit dihapus setelah operasi flush. Defaultnya adalah false (salah). Data pada offset kurang dari posisi yang ditentukan ditulis ke file ketika flush berhasil, tetapi parameter opsional ini memungkinkan data setelah posisi flush dipertahankan untuk operasi flush di masa mendatang. |
|
timeout
|
query |
integer int32 |
Nilai batas waktu operasi opsional dalam hitung detik. Periode dimulai ketika permintaan diterima oleh layanan. Jika nilai batas waktu berlalu sebelum operasi selesai, operasi gagal. |
Header Permintaan
Media Types: "application/octet-stream", "text/plain"
Nama | Diperlukan | Jenis | Deskripsi |
---|---|---|---|
Content-Length |
integer int64 |
Diperlukan untuk "Tambahkan Data" dan "Flush Data". Harus 0 untuk "Flush Data". Harus panjang konten permintaan dalam byte untuk "Tambahkan Data". |
|
Content-MD5 |
string |
Pilihan. Hash MD5 dari konten permintaan. Header ini valid pada operasi "Tambahkan" dan "Flush". Hash ini digunakan untuk memverifikasi integritas konten permintaan selama transportasi. Ketika header ini ditentukan, layanan penyimpanan membandingkan hash konten yang telah tiba dengan nilai header ini. Jika dua hash tidak cocok, operasi akan gagal dengan kode kesalahan 400 (Permintaan Buruk). Perhatikan bahwa hash MD5 ini tidak disimpan dengan file . Header ini dikaitkan dengan konten permintaan, dan bukan dengan konten file yang disimpan itu sendiri. |
|
x-ms-lease-id |
string |
ID sewa harus ditentukan jika ada sewa aktif. Tidak valid untuk operasi "setAccessControlRecursive". Pola regex: |
|
x-ms-cache-control |
string |
Opsional dan hanya berlaku untuk operasi flush dan set properti. Layanan menyimpan nilai ini dan menyertakannya di header respons "Cache-Control" untuk operasi "Baca File". |
|
x-ms-content-type |
string |
Opsional dan hanya berlaku untuk operasi flush dan set properti. Layanan menyimpan nilai ini dan menyertakannya di header respons "Jenis Konten" untuk operasi "Baca File". |
|
x-ms-content-disposition |
string |
Opsional dan hanya berlaku untuk operasi flush dan set properti. Layanan menyimpan nilai ini dan menyertakannya di header respons "Content-Disposition" untuk operasi "Baca File". |
|
x-ms-content-encoding |
string |
Opsional dan hanya berlaku untuk operasi flush dan set properti. Layanan menyimpan nilai ini dan menyertakannya di header respons "Pengodean Konten" untuk operasi "Baca File". |
|
x-ms-content-language |
string |
Opsional dan hanya berlaku untuk operasi flush dan set properti. Layanan menyimpan nilai ini dan menyertakannya di header respons "Content-Language" untuk operasi "Baca File". |
|
x-ms-content-md5 |
string |
Opsional dan hanya valid untuk operasi "Hapus dan Atur Properti". Layanan menyimpan nilai ini dan menyertakannya di header respons "Content-Md5" untuk operasi "Baca dan Dapatkan Properti". Jika properti ini tidak ditentukan pada permintaan, maka properti akan dihapus untuk file. Panggilan berikutnya ke "Properti Baca dan Dapatkan" tidak akan mengembalikan properti ini kecuali secara eksplisit diatur pada file itu lagi. |
|
x-ms-properties |
string |
Pilihan. Properti yang ditentukan pengguna untuk disimpan dengan file atau direktori, dalam format daftar pasangan nama dan nilai yang dipisahkan koma "n1=v1, n2=v2, ...", di mana setiap nilai adalah string yang dikodekan base64. Perhatikan bahwa string hanya boleh berisi karakter ASCII dalam set karakter ISO-8859-1. Hanya berlaku untuk operasi setProperties. Jika file atau direktori ada, properti apa pun yang tidak disertakan dalam daftar akan dihapus. Semua properti dihapus jika header dihilangkan. Untuk menggabungkan properti baru dan yang sudah ada, pertama-tama dapatkan semua properti yang ada dan E-Tag saat ini, lalu buat permintaan kondisional dengan E-Tag dan sertakan nilai untuk semua properti. |
|
x-ms-owner |
string |
Opsional dan hanya valid untuk operasi setAccessControl. Mengatur pemilik file atau direktori. |
|
x-ms-group |
string |
Opsional dan hanya valid untuk operasi setAccessControl. Mengatur grup pemilik file atau direktori. |
|
x-ms-permissions |
string |
Opsional dan hanya valid jika Namespace Hierarki diaktifkan untuk akun tersebut. Mengatur izin akses POSIX untuk pemilik file, grup pemilik file, dan lainnya. Setiap kelas dapat diberikan izin baca (4), tulis (2), atau jalankan (1). Notasi simbolis (rwxrw-rw-) dan oktal 4 digit (misalnya 0766) didukung. Bit lengket juga didukung dan dalam notasi simbolis, yang diwakili baik oleh huruf t atau T di tempat karakter akhir tergantung pada apakah bit eksekusi untuk kategori lain diatur atau tidak diatur masing-masing (misalnya rwxrw-rw- dengan bit lengket direpresentasikan sebagai rwxrw-rwT. Rwxrw-rwx dengan bit lengket direpresentasikan sebagai rwxrw-rwt), tidak adanya t atau T menunjukkan bit lengket tidak diatur. Dalam notasi oktal 4 digit, diwakili oleh digit pertama (misalnya 1766 mewakili rwxrw-rw- dengan bit lengket dan 0766 mewakili rwxrw-rw- tanpa bit lengket). Tidak valid bersama dengan x-ms-acl. |
|
x-ms-acl |
string |
Opsional dan valid hanya untuk operasi setAccessControl dan setAccessControlRecursive. Diperlukan untuk operasi setAccessControlRecursive. Mengatur hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma yang sepenuhnya menggantikan daftar kontrol akses (ACL) yang ada jika setAccessControl dan mode "set" setAccessControlRecursive. Mode "modifikasi" setAccessControlRecursive memperbarui ACLS yang sudah ada sebelumnya. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, pengidentifikasi pengguna atau grup, dan izin dalam format "[scope:][type]:[id]:[permissions]". Cakupan harus "default" untuk menunjukkan ACE milik ACL default untuk direktori; jika tidak, cakupan bersifat implisit dan ACE milik ACL akses. Ada empat jenis ACE: "pengguna" memberikan hak kepada pemilik atau pengguna bernama, "grup" memberikan hak kepada grup pemilik atau grup bernama, "mask" membatasi hak yang diberikan kepada pengguna bernama dan anggota grup, dan hak pemberian "lainnya" kepada semua pengguna yang tidak ditemukan di salah satu entri lainnya. Pengidentifikasi pengguna atau grup dihilangkan untuk entri jenis "masker" dan "lainnya". Pengidentifikasi pengguna atau grup juga dihilangkan untuk pemilik dan grup pemilik. Bidang izin adalah urutan 3 karakter di mana karakter pertama adalah 'r' untuk memberikan akses baca, karakter kedua adalah 'w' untuk memberikan akses tulis, dan karakter ketiga adalah 'x' untuk memberikan izin eksekusi. Jika akses tidak diberikan, karakter '-' digunakan untuk menunjukkan bahwa izin ditolak. Misalnya, ACL berikut memberikan hak baca, tulis, dan eksekusi kepada pemilik file dan john.doe@contoso, hak baca untuk grup pemilik, dan tidak ada bagi orang lain: "user::rwx,user:john.doe@contoso:rwx,group::r--,other::---,mask=rwx". Tidak valid bersama dengan x-ms-permissions. Mode "hapus" setAccessControlRecursive menghapus ACL yang sudah ada sebelumnya dan tidak boleh berisi izin dalam daftar kontrol akses yang ditentukan : "user:john.doe@contoso:, mask:". Mode "set" dari setAccessControlRecursive mengatur ACL yang menggantikan ACL yang sudah ada sebelumnya dari cakupan yang ditentukan dan harus berisi ketiganya - pengguna pemilik, grup pemilik, dan info lain jika cakupan akses diatur atau jika salah satu dari pengguna pemilik, grup pemilik atau lainnya sedang diatur dalam cakupan default. Mode "set" dan "modifikasi" setAccessControlRecursive harus berisi izin sebagai bagian dari daftar kontrol akses. |
|
If-Match |
string |
Opsional untuk Data Flush, Atur Access Control dan Atur Properti, tetapi tidak valid untuk Tambahkan Data dan Atur Access Control Rekursif. Nilai ETag. Tentukan header ini untuk melakukan operasi hanya jika ETag sumber daya cocok dengan nilai yang ditentukan. ETag harus ditentukan dalam tanda kutip. |
|
If-None-Match |
string |
Opsional untuk Data Flush, Atur Access Control dan Atur Properti, tetapi tidak valid untuk Tambahkan Data dan Atur Access Control Rekursif. Nilai ETag atau nilai wildcard khusus ("*"). Tentukan header ini untuk melakukan operasi hanya jika ETag sumber daya tidak cocok dengan nilai yang ditentukan. ETag harus ditentukan dalam tanda kutip. |
|
If-Modified-Since |
string |
Opsional untuk Hapus Data dan Atur Properti, tetapi tidak valid untuk Tambahkan Data dan Atur Access Control Rekursif. Nilai tanggal dan waktu. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak tanggal dan waktu yang ditentukan. |
|
If-Unmodified-Since |
string |
Opsional untuk Hapus Data dan Atur Properti, tetapi tidak valid untuk Tambahkan Data dan Atur Access Control Rekursif. Nilai tanggal dan waktu. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal dan waktu yang ditentukan. |
|
x-ms-encryption-key |
string |
Pilihan. Kunci enkripsi AES-256 yang dikodekan Base64. |
|
x-ms-encryption-key-sha256 |
string |
Pilihan. Hash SHA256 yang dikodekan Base64 dari kunci enkripsi. |
|
x-ms-encryption-algorithm: AES256 |
string |
Pilihan. Menentukan algoritma yang akan digunakan untuk enkripsi. Nilai header ini harus AES256. |
|
x-ms-lease-action | True |
Dimulai dengan versi 2020-08-04 dalam operasi tambahkan dan hapus. Append mendukung tindakan 'acquire', 'auto-renew' dan 'acquire-release'. Jika 'memperoleh' itu akan memperoleh sewa. Jika 'perpanjangan otomatis' akan memperpanjang sewa. Jika 'acquire-release' ia akan memperoleh & menyelesaikan operasi & melepaskan sewa setelah operasi selesai. Tindakan 'Rilis' hanya didukung dalam operasi flush. Jika 'true', akan merilis sewa pada file menggunakan info id sewa dari header x-ms-lease-id. |
|
x-ms-lease-duration |
integer int32 |
Durasi sewa diperlukan untuk memperoleh sewa, dan menentukan durasi sewa dalam hitungan detik. Durasi sewa harus antara 15 dan 60 detik atau -1 untuk sewa tak terbatas. |
|
x-ms-proposed-lease-id |
string |
Diperlukan ketika "x-ms-lease-action" adalah "acquire" atau "change". Sewa akan diperoleh dengan ID sewa ini jika operasi berhasil. Pola regex: |
|
x-ms-client-request-id |
string |
UUID yang dicatat dalam log analitik untuk pemecahan masalah dan korelasi. Pola regex: |
|
x-ms-date |
string |
Menentukan Waktu Universal Terkoordinasi (UTC) untuk permintaan tersebut. Ini diperlukan saat menggunakan otorisasi kunci bersama. |
|
x-ms-version |
string |
Menentukan versi protokol REST yang digunakan untuk memproses permintaan. Ini diperlukan saat menggunakan otorisasi kunci bersama. |
Isi Permintaan
Media Types: "application/octet-stream", "text/plain"
Nama | Jenis | Deskripsi |
---|---|---|
requestBody |
object |
Hanya berlaku untuk operasi penampan. Data yang akan diunggah dan ditambahkan ke file. |
Respons
Nama | Jenis | Deskripsi |
---|---|---|
200 OK |
Data dibersihkan (ditulis) ke file atau properti berhasil diatur. Isi respons bersifat opsional dan hanya valid untuk "SetAccessControlRecursive" Header
|
|
202 Accepted |
Data yang diunggah diterima. Header
|
|
Other Status Codes |
Terjadi kesalahan. Kemungkinan status HTTP, kode, dan string pesan tercantum di bawah ini:
Header
|
Definisi
Nama | Deskripsi |
---|---|
Acl |
|
Data |
|
Error |
Objek respons kesalahan layanan. |
Path |
Dimulai dengan versi 2020-08-04 dalam operasi penampan dan pembilasan. Tambahkan mendukung tindakan 'acquire', 'auto-renew' dan 'acquire-release'. Jika 'memperoleh' itu akan memperoleh sewa. Jika 'perpanjangan otomatis' itu akan memperbarui sewa. Jika 'acquire-release' akan memperoleh & menyelesaikan operasi & melepaskan sewa setelah operasi selesai. Tindakan 'Rilis' hanya didukung dalam operasi flush. Jika 'true', akan merilis sewa pada file menggunakan info id sewa dari header x-ms-lease-id. |
Path |
Tindakan harus "ditambahkan" untuk mengunggah data yang akan ditambahkan ke file, "flush" untuk membersihkan data yang sebelumnya diunggah ke file, "setProperties" untuk mengatur properti file atau direktori, atau "setAccessControl" untuk mengatur pemilik, grup, izin, atau daftar kontrol akses untuk file atau direktori, atau "setAccessControlRecursive" untuk mengatur daftar kontrol akses untuk direktori secara rekursif. Perhatikan bahwa Namespace Hierarkis harus diaktifkan untuk akun agar dapat menggunakan kontrol akses. Perhatikan juga bahwa Daftar Access Control (ACL) mencakup izin untuk pemilik, grup pemilik, dan lainnya, sehingga header permintaan x-ms-permissions dan x-ms-acl saling eksklusif. |
Set |
AclFailedEntryList
Nama | Jenis | Deskripsi |
---|---|---|
errorMessage |
string |
|
name |
string |
|
type |
string |
DataLakeStorageError
Nama | Jenis | Deskripsi |
---|---|---|
error |
Objek respons kesalahan layanan. |
Error
Objek respons kesalahan layanan.
Nama | Jenis | Deskripsi |
---|---|---|
code |
string |
Kode kesalahan layanan. |
message |
string |
Pesan kesalahan layanan. |
PathLeaseAction
Dimulai dengan versi 2020-08-04 dalam operasi penampan dan pembilasan. Tambahkan mendukung tindakan 'acquire', 'auto-renew' dan 'acquire-release'. Jika 'memperoleh' itu akan memperoleh sewa. Jika 'perpanjangan otomatis' itu akan memperbarui sewa. Jika 'acquire-release' akan memperoleh & menyelesaikan operasi & melepaskan sewa setelah operasi selesai. Tindakan 'Rilis' hanya didukung dalam operasi flush. Jika 'true', akan merilis sewa pada file menggunakan info id sewa dari header x-ms-lease-id.
Nama | Jenis | Deskripsi |
---|---|---|
acquire |
string |
|
acquire-release |
string |
|
auto-renew |
string |
|
release |
string |
PathUpdateAction
Tindakan harus "ditambahkan" untuk mengunggah data yang akan ditambahkan ke file, "flush" untuk membersihkan data yang sebelumnya diunggah ke file, "setProperties" untuk mengatur properti file atau direktori, atau "setAccessControl" untuk mengatur pemilik, grup, izin, atau daftar kontrol akses untuk file atau direktori, atau "setAccessControlRecursive" untuk mengatur daftar kontrol akses untuk direktori secara rekursif. Perhatikan bahwa Namespace Hierarkis harus diaktifkan untuk akun agar dapat menggunakan kontrol akses. Perhatikan juga bahwa Daftar Access Control (ACL) mencakup izin untuk pemilik, grup pemilik, dan lainnya, sehingga header permintaan x-ms-permissions dan x-ms-acl saling eksklusif.
Nama | Jenis | Deskripsi |
---|---|---|
append |
string |
|
flush |
string |
|
setAccessControl |
string |
|
setAccessControlRecursive |
string |
|
setProperties |
string |
SetAccessControlRecursiveResponse
Nama | Jenis | Deskripsi |
---|---|---|
directoriesSuccessful |
integer |
|
failedEntries | ||
failureCount |
integer |
|
filesSuccessful |
integer |