DataLakeDirectoryClient Kelas
Klien untuk berinteraksi dengan direktori DataLake, bahkan jika direktori mungkin belum ada.
Untuk operasi yang berkaitan dengan subdirektori atau file tertentu di bawah direktori, klien direktori atau klien file dapat diambil menggunakan get_sub_directory_client fungsi atau get_file_client .
- Warisan
-
azure.storage.filedatalake._path_client.PathClientDataLakeDirectoryClient
Konstruktor
DataLakeDirectoryClient(account_url: str, file_system_name: str, directory_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)
Parameter
- directory_name
- str
Seluruh jalur direktori. misalnya. {directory under file system}/{directory to interact with}
- credential
Kredensial yang digunakan untuk mengautentikasi. Ini bersifat opsional jika URL akun sudah memiliki token SAS. Nilainya dapat berupa string token SAS, instans AzureSasCredential atau AzureNamedKeyCredential dari azure.core.credentials, kunci akses bersama akun, atau instans kelas TokenCredentials dari azure.identity. Jika URI sumber daya sudah berisi token SAS, ini akan diabaikan demi kredensial eksplisit
- kecuali dalam kasus AzureSasCredential, di mana token SAS yang bertentangan akan menaikkan ValueError. Jika menggunakan instans AzureNamedKeyCredential, "nama" harus menjadi nama akun penyimpanan, dan "kunci" harus menjadi kunci akun penyimpanan.
- api_version
- str
Versi Storage API yang digunakan untuk permintaan. Nilai default adalah versi layanan terbaru yang kompatibel dengan SDK saat ini. Pengaturan ke versi yang lebih lama dapat mengakibatkan kompatibilitas fitur yang berkurang.
Contoh
Membuat DataLakeServiceClient dari string koneksi.
from azure.storage.filedatalake import DataLakeDirectoryClient
DataLakeDirectoryClient.from_connection_string(connection_string, "myfilesystem", "mydirectory")
Variabel
- url
- str
URL titik akhir lengkap ke sistem file, termasuk token SAS jika digunakan.
- primary_endpoint
- str
URL titik akhir utama lengkap.
- primary_hostname
- str
Nama host titik akhir utama.
Metode
acquire_lease |
Meminta sewa baru. Jika file atau direktori tidak memiliki sewa aktif, layanan DataLake membuat sewa pada file/direktori dan mengembalikan ID sewa baru. |
close |
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks. |
create_directory |
Buat direktori baru. |
create_file |
Buat file baru dan kembalikan klien file untuk berinteraksi. |
create_sub_directory |
Buat subdirektori dan kembalikan klien subdirektori yang akan berinteraksi. |
delete_directory |
Menandai direktori yang ditentukan untuk penghapusan. |
delete_sub_directory |
Menandai subdirektori yang ditentukan untuk penghapusan. |
exists |
Mengembalikan True jika ada direktori dan mengembalikan False jika tidak. |
from_connection_string |
Buat DataLakeDirectoryClient dari String Koneksi. |
get_access_control | |
get_directory_properties |
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk direktori. Ini tidak mengembalikan konten direktori. |
get_file_client |
Mendapatkan klien untuk berinteraksi dengan file yang ditentukan. File belum ada. |
get_sub_directory_client |
Dapatkan klien untuk berinteraksi dengan subdirektori yang ditentukan dari direktori saat ini. Subdirektori belum ada. |
remove_access_control_recursive |
Menghapus Access Control pada jalur dan sub-jalur. |
rename_directory |
Ganti nama direktori sumber. |
set_access_control |
Atur pemilik, grup, izin, atau daftar kontrol akses untuk jalur. |
set_access_control_recursive |
Mengatur Access Control pada jalur dan sub-jalur. |
set_http_headers |
Menyetel properti sistem pada file atau direktori. Jika satu properti diatur untuk content_settings, semua properti akan ditimpa. |
set_metadata |
Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk sistem file yang ditentukan. Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang terlampir pada sistem file. Untuk menghapus semua metadata dari sistem file, panggil operasi ini tanpa dict metadata. |
update_access_control_recursive |
Memodifikasi Access Control pada jalur dan sub-jalur. |
acquire_lease
Meminta sewa baru. Jika file atau direktori tidak memiliki sewa aktif, layanan DataLake membuat sewa pada file/direktori dan mengembalikan ID sewa baru.
acquire_lease(lease_duration: int | None = -1, lease_id: str | None = None, **kwargs) -> DataLakeLeaseClient
Parameter
- lease_duration
- int
Menentukan durasi sewa, dalam detik, atau negatif satu (-1) untuk sewa yang tidak pernah kedaluwarsa. Sewa yang tidak terbatas bisa antara 15 dan 60 detik. Durasi sewa tidak dapat diubah menggunakan pembaruan atau perubahan. Defaultnya adalah -1 (sewa tak terbatas).
- lease_id
- str
ID sewa yang diusulkan, dalam format string GUID. Layanan DataLake mengembalikan 400 (Permintaan tidak valid) jika ID sewa yang diusulkan tidak dalam format yang benar.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Objek DataLakeLeaseClient, yang dapat dijalankan di manajer konteks.
Tipe hasil
close
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks.
close() -> None
create_directory
Buat direktori baru.
create_directory(metadata: Dict[str, str] | None = None, **kwargs) -> Dict[str, str | datetime]
Parameter
- content_settings
- ContentSettings
Objek ContentSettings yang digunakan untuk mengatur properti jalur.
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat berupa objek DataLakeLeaseClient atau ID sewa sebagai string.
- umask
- str
Opsional dan hanya valid jika Namespace Hierarki diaktifkan untuk akun tersebut. Saat membuat file atau direktori dan folder induk tidak memiliki ACL default, umask membatasi izin file atau direktori yang akan dibuat. Izin yang dihasilkan diberikan oleh p & ^u, di mana p adalah izin dan Anda adalah umask. Misalnya, jika p adalah 0777 dan Anda adalah 0057, maka izin yang dihasilkan adalah 0720. Izin default adalah 0777 untuk direktori dan 0666 untuk file. Umask default adalah 0027. Umask harus ditentukan dalam notasi oktal 4 digit (misalnya 0766).
- owner
- str
Pemilik file atau direktori.
- group
- str
Grup pemilik file atau direktori.
- acl
- str
Mengatur hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, pengidentifikasi pengguna atau grup, dan izin dalam format "[scope:][type]:[id]:[permissions]".
- lease_id
- str
ID sewa yang diusulkan, dalam format string GUID. Layanan DataLake mengembalikan 400 (Permintaan tidak valid) jika ID sewa yang diusulkan tidak dalam format yang benar.
- lease_duration
- int
Menentukan durasi sewa, dalam detik, atau negatif satu (-1) untuk sewa yang tidak pernah kedaluwarsa. Sewa yang tidak terbatas bisa antara 15 dan 60 detik. Durasi sewa tidak dapat diubah menggunakan pembaruan atau perubahan.
- permissions
- str
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, tulis, atau eksekusi. Bit lengket juga didukung. Baik simbolis (rwxrw-rw-) dan notasi oktal 4 digit (misalnya 0766) didukung.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
Mengenkripsi data di sisi layanan dengan kunci yang diberikan. Penggunaan kunci yang disediakan pelanggan harus dilakukan melalui HTTPS.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Kamus header respons.
Tipe hasil
Contoh
Buat direktori.
directory_client.create_directory()
create_file
Buat file baru dan kembalikan klien file untuk berinteraksi.
create_file(file: FileProperties | str, **kwargs) -> DataLakeFileClient
Parameter
- file
- str atau FileProperties
File yang digunakan untuk berinteraksi. Ini bisa berupa nama file, atau instans FileProperties.
- content_settings
- ContentSettings
Objek ContentSettings yang digunakan untuk mengatur properti jalur.
- metadata
Pasangan nama-nilai yang terkait dengan file sebagai metadata.
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat berupa objek DataLakeLeaseClient atau ID sewa sebagai string.
- umask
- str
Opsional dan hanya valid jika Namespace Hierarki diaktifkan untuk akun tersebut. Saat membuat file atau direktori dan folder induk tidak memiliki ACL default, umask membatasi izin file atau direktori yang akan dibuat. Izin yang dihasilkan diberikan oleh p & ^u, di mana p adalah izin dan Anda adalah umask. Misalnya, jika p adalah 0777 dan Anda adalah 0057, maka izin yang dihasilkan adalah 0720. Izin default adalah 0777 untuk direktori dan 0666 untuk file. Umask default adalah 0027. Umask harus ditentukan dalam notasi oktal 4 digit (misalnya 0766).
- owner
- str
Pemilik file atau direktori.
- group
- str
Grup pemilik file atau direktori.
- acl
- str
Mengatur hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, pengidentifikasi pengguna atau grup, dan izin dalam format "[scope:][type]:[id]:[permissions]".
- lease_id
- str
ID sewa yang diusulkan, dalam format string GUID. Layanan DataLake mengembalikan 400 (Permintaan tidak valid) jika ID sewa yang diusulkan tidak dalam format yang benar.
- lease_duration
- int
Menentukan durasi sewa, dalam detik, atau negatif satu (-1) untuk sewa yang tidak pernah kedaluwarsa. Sewa yang tidak terbatas bisa antara 15 dan 60 detik. Durasi sewa tidak dapat diubah menggunakan pembaruan atau perubahan.
Waktu untuk mengatur file ke kedaluwarsa. Jika jenis expires_on adalah int, waktu kedaluwarsa akan ditetapkan sebagai jumlah milidetik yang berlalu dari waktu pembuatan. Jika jenis expires_on adalah tanggalwaktu, waktu kedaluwarsa akan diatur absolut ke waktu yang disediakan. Jika tidak ada info zona waktu yang disediakan, ini akan ditafsirkan sebagai UTC.
- permissions
- str
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, tulis, atau eksekusi. Bit lengket juga didukung. Baik simbolis (rwxrw-rw-) dan notasi oktal 4 digit (misalnya 0766) didukung.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
Mengenkripsi data di sisi layanan dengan kunci yang diberikan. Penggunaan kunci yang disediakan pelanggan harus dilakukan melalui HTTPS.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
DataLakeFileClient
create_sub_directory
Buat subdirektori dan kembalikan klien subdirektori yang akan berinteraksi.
create_sub_directory(sub_directory: DirectoryProperties | str, metadata: Dict[str, str] | None = None, **kwargs) -> DataLakeDirectoryClient
Parameter
- sub_directory
- str atau DirectoryProperties
Direktori yang akan berinteraksi. Ini bisa berupa nama direktori, atau instans DirectoryProperties.
- content_settings
- ContentSettings
Objek ContentSettings yang digunakan untuk mengatur properti jalur.
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat berupa objek DataLakeLeaseClient atau ID sewa sebagai string.
- umask
- str
Opsional dan hanya valid jika Namespace Hierarki diaktifkan untuk akun tersebut. Saat membuat file atau direktori dan folder induk tidak memiliki ACL default, umask membatasi izin file atau direktori yang akan dibuat. Izin yang dihasilkan diberikan oleh p & ^u, di mana p adalah izin dan Anda adalah umask. Misalnya, jika p adalah 0777 dan Anda adalah 0057, maka izin yang dihasilkan adalah 0720. Izin default adalah 0777 untuk direktori dan 0666 untuk file. Umask default adalah 0027. Umask harus ditentukan dalam notasi oktal 4 digit (misalnya 0766).
- owner
- str
Pemilik file atau direktori.
- group
- str
Grup pemilik file atau direktori.
- acl
- str
Mengatur hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, pengidentifikasi pengguna atau grup, dan izin dalam format "[scope:][type]:[id]:[permissions]".
- lease_id
- str
ID sewa yang diusulkan, dalam format string GUID. Layanan DataLake mengembalikan 400 (Permintaan tidak valid) jika ID sewa yang diusulkan tidak dalam format yang benar.
- lease_duration
- int
Menentukan durasi sewa, dalam detik, atau negatif satu (-1) untuk sewa yang tidak pernah kedaluwarsa. Sewa yang tidak terbatas bisa antara 15 dan 60 detik. Durasi sewa tidak dapat diubah menggunakan pembaruan atau perubahan.
- permissions
- str
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, tulis, atau eksekusi. Bit lengket juga didukung. Baik simbolis (rwxrw-rw-) dan notasi oktal 4 digit (misalnya 0766) didukung.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
Mengenkripsi data di sisi layanan dengan kunci yang diberikan. Penggunaan kunci yang disediakan pelanggan harus dilakukan melalui HTTPS.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
DataLakeDirectoryClient untuk subdirektori.
delete_directory
Menandai direktori yang ditentukan untuk penghapusan.
delete_directory(**kwargs) -> None
Parameter
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek LeaseClient atau ID sewa sebagai string.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Tidak ada
Contoh
Hapus direktori.
new_directory.delete_directory()
delete_sub_directory
Menandai subdirektori yang ditentukan untuk penghapusan.
delete_sub_directory(sub_directory: DirectoryProperties | str, **kwargs) -> DataLakeDirectoryClient
Parameter
- sub_directory
- str atau DirectoryProperties
Direktori untuk berinteraksi. Ini bisa menjadi nama direktori, atau instans DirectoryProperties.
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek LeaseClient atau ID sewa sebagai string.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
DataLakeDirectoryClient untuk subdirektori
exists
Mengembalikan True jika ada direktori dan mengembalikan False jika tidak.
exists(**kwargs: Any) -> bool
Parameter
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
True jika ada direktori, Salah jika tidak.
Tipe hasil
from_connection_string
Buat DataLakeDirectoryClient dari String Koneksi.
from_connection_string(conn_str: str, file_system_name: str, directory_name: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parameter
- credential
Kredensial yang digunakan untuk mengautentikasi. Ini opsional jika URL akun sudah memiliki token SAS. Nilainya dapat berupa string token SAS, instans AzureSasCredential atau AzureNamedKeyCredential dari azure.core.credentials, kunci akses bersama akun, atau instans kelas TokenCredentials dari azure.identity. Jika URI sumber daya sudah berisi token SAS, ini akan diabaikan demi kredensial eksplisit
- kecuali dalam kasus AzureSasCredential, di mana token SAS yang bertentangan akan memunculkan ValueError. Jika menggunakan instans AzureNamedKeyCredential, "nama" harus menjadi nama akun penyimpanan, dan "kunci" harus menjadi kunci akun penyimpanan.
- directory_name
- str
Nama direktori untuk berinteraksi. Direktori berada di bawah sistem file.
- credential
Kredensial yang digunakan untuk mengautentikasi. Ini bersifat opsional jika URL akun sudah memiliki token SAS, atau string koneksi sudah memiliki nilai kunci akses bersama. Nilainya dapat berupa string token SAS, instans AzureSasCredential atau AzureNamedKeyCredential dari azure.core.credentials, kunci akses bersama akun, atau instans kelas TokenCredentials dari azure.identity. Kredensial yang disediakan di sini akan lebih diutamakan daripada yang ada dalam string koneksi. Jika menggunakan instans AzureNamedKeyCredential, "nama" harus menjadi nama akun penyimpanan, dan "kunci" harus menjadi kunci akun penyimpanan.
Mengembalikan
DataLakeDirectoryClient
Tipe hasil
get_access_control
get_access_control(upn: bool | None = None, **kwargs) -> Dict[str, Any]
Parameter
- upn
- bool
Pilihan. Hanya berlaku saat Namespace Hierarki diaktifkan untuk akun tersebut. Jika "true", nilai identitas pengguna yang dikembalikan di header respons x-ms-owner, x-ms-group, dan x-ms-acl akan diubah dari ID Objek Azure Active Directory menjadi Nama Utama Pengguna. Jika "false", nilai akan dikembalikan sebagai ID Objek Azure Active Directory. Nilai defaultnya adalah false. Perhatikan bahwa ID Objek grup dan aplikasi tidak diterjemahkan karena tidak memiliki nama ramah yang unik.
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file/direktori memiliki sewa aktif. Nilai dapat menjadi objek LeaseClient atau ID sewa sebagai string.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
- response dict
tanggapan dict.
get_directory_properties
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk direktori. Ini tidak mengembalikan konten direktori.
get_directory_properties(**kwargs: Any) -> DirectoryProperties
Parameter
- lease
- DataLakeLeaseClient atau str
Diperlukan jika direktori atau file memiliki sewa aktif. Nilai dapat berupa objek DataLakeLeaseClient atau ID sewa sebagai string.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
Mendekripsi data di sisi layanan dengan kunci yang diberikan. Penggunaan kunci yang disediakan pelanggan harus dilakukan melalui HTTPS. Diperlukan jika direktori dibuat dengan kunci yang disediakan pelanggan.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Tipe hasil
Contoh
Mendapatkan properti untuk file/direktori.
props = new_directory.get_directory_properties()
get_file_client
Mendapatkan klien untuk berinteraksi dengan file yang ditentukan.
File belum ada.
get_file_client(file: FileProperties | str) -> DataLakeFileClient
Parameter
- file
- str atau FileProperties
File yang digunakan untuk berinteraksi. Ini bisa berupa nama file, atau instans FileProperties. Misalnya. direktori/subdirektori/file
Mengembalikan
A DataLakeFileClient.
Tipe hasil
get_sub_directory_client
Dapatkan klien untuk berinteraksi dengan subdirektori yang ditentukan dari direktori saat ini.
Subdirektori belum ada.
get_sub_directory_client(sub_directory: DirectoryProperties | str) -> DataLakeDirectoryClient
Parameter
- sub_directory
- str atau DirectoryProperties
Direktori yang akan berinteraksi. Ini bisa berupa nama direktori, atau instans DirectoryProperties.
Mengembalikan
A DataLakeDirectoryClient.
Tipe hasil
remove_access_control_recursive
Menghapus Access Control pada jalur dan sub-jalur.
remove_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult
Parameter
- acl
- str
Menghapus hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, dan pengidentifikasi pengguna atau grup dalam format "[scope:][type]:[id]".
- progress_hook
- <xref:func>(AccessControlChanges)
Panggilan balik tempat penelepon dapat melacak kemajuan operasi serta mengumpulkan jalur yang gagal diubah Access Control.
- continuation_token
- str
Token kelanjutan opsional yang dapat digunakan untuk melanjutkan operasi yang dihentikan sebelumnya.
- batch_size
- int
Pilihan. Jika ukuran himpunan data melebihi ukuran batch, maka operasi akan dibagi menjadi beberapa permintaan sehingga kemajuan dapat dilacak. Ukuran batch harus antara 1 dan 2000. Default saat tidak ditentukan adalah 2000.
- max_batches
- int
Pilihan. Menentukan jumlah maksimum batch yang dapat dijalankan oleh operasi Access Control perubahan tunggal. Jika maksimum tercapai sebelum semua sub-jalur diproses, token kelanjutan dapat digunakan untuk melanjutkan operasi. Nilai kosong menunjukkan bahwa jumlah maksimum batch dalam unbound dan operasi berlanjut hingga akhir.
- continue_on_failure
- bool
Jika diatur ke False, operasi akan berakhir dengan cepat saat mengalami kesalahan pengguna (4XX). Jika True, operasi akan mengabaikan kesalahan pengguna dan melanjutkan operasi pada sub-entitas lain dari direktori. Token kelanjutan hanya akan dikembalikan ketika continue_on_failure True jika terjadi kesalahan pengguna. Jika tidak diatur, nilai defaultnya adalah False untuk ini.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Ringkasan operasi rekursif, termasuk jumlah keberhasilan dan kegagalan, serta token kelanjutan jika operasi dihentikan sebelum waktunya.
Tipe hasil
Pengecualian
Pengguna dapat memulai ulang operasi menggunakan bidang continuation_token AzureError jika token tersedia.
rename_directory
Ganti nama direktori sumber.
rename_directory(new_name: str, **kwargs: Any) -> DataLakeDirectoryClient
Parameter
- new_name
- str
nama direktori baru yang ingin diganti namanya oleh pengguna. Nilai harus memiliki format berikut: "{filesystem}/{directory}/{subdirektori}".
- source_lease
- DataLakeLeaseClient atau str
ID sewa untuk jalur sumber. Jika ditentukan, jalur sumber harus memiliki sewa aktif dan ID sewa harus cocok.
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file/direktori memiliki sewa aktif. Nilai dapat menjadi objek LeaseClient atau ID sewa sebagai string.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
- source_if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- source_if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- source_etag
- str
Nilai ETag sumber, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- source_match_condition
- MatchConditions
Kondisi kecocokan sumber untuk digunakan pada etag.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
DataLakeDirectoryClient
Contoh
Ganti nama direktori sumber.
new_dir_name = "testdir2"
print("Renaming the directory named '{}' to '{}'.".format(dir_name, new_dir_name))
new_directory = directory_client\
.rename_directory(new_name=directory_client.file_system_name + '/' + new_dir_name)
set_access_control
Atur pemilik, grup, izin, atau daftar kontrol akses untuk jalur.
set_access_control(owner: str | None = None, group: str | None = None, permissions: str | None = None, acl: str | None = None, **kwargs) -> Dict[str, str | datetime]
Parameter
- permissions
- str
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, tulis, atau jalankan. Bit lengket juga didukung. Notasi simbolis (rwxrw-rw-) dan oktal 4 digit (misalnya 0766) didukung. izin dan acl saling eksklusif.
- acl
- str
Mengatur hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, pengidentifikasi pengguna atau grup, dan izin dalam format "[scope:][type]:[id]:[permissions]". izin dan acl saling eksklusif.
- lease
- DataLakeLeaseClient atau str
Diperlukan jika file/direktori memiliki sewa aktif. Nilai dapat menjadi objek LeaseClient atau ID sewa sebagai string.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
- response dict
dict respons (Etag dan terakhir dimodifikasi).
set_access_control_recursive
Mengatur Access Control pada jalur dan sub-jalur.
set_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult
Parameter
- acl
- str
Mengatur hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, pengidentifikasi pengguna atau grup, dan izin dalam format "[scope:][type]:[id]:[permissions]".
- progress_hook
- <xref:func>(AccessControlChanges)
Panggilan balik tempat pemanggil dapat melacak kemajuan operasi serta mengumpulkan jalur yang gagal diubah Access Control.
- continuation_token
- str
Token kelanjutan opsional yang dapat digunakan untuk melanjutkan operasi yang dihentikan sebelumnya.
- batch_size
- int
Pilihan. Jika ukuran himpunan data melebihi ukuran batch, maka operasi akan dibagi menjadi beberapa permintaan sehingga kemajuan dapat dilacak. Ukuran batch harus antara 1 dan 2000. Default saat tidak ditentukan adalah 2000.
- max_batches
- int
Pilihan. Menentukan jumlah maksimum batch yang dapat dijalankan oleh operasi Access Control perubahan tunggal. Jika maksimum tercapai sebelum semua sub-jalur diproses, maka token kelanjutan dapat digunakan untuk melanjutkan operasi. Nilai kosong menunjukkan bahwa jumlah maksimum batch dalam unbound dan operasi berlanjut hingga akhir.
- continue_on_failure
- bool
Jika diatur ke False, operasi akan berakhir dengan cepat saat mengalami kesalahan pengguna (4XX). Jika True, operasi akan mengabaikan kesalahan pengguna dan melanjutkan operasi pada sub-entitas lain dari direktori. Token kelanjutan hanya akan dikembalikan ketika continue_on_failure True jika terjadi kesalahan pengguna. Jika tidak diatur, nilai defaultnya adalah False untuk ini.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Ringkasan operasi rekursif, termasuk jumlah keberhasilan dan kegagalan, serta token kelanjutan jika operasi dihentikan sebelum waktunya.
Tipe hasil
Pengecualian
Pengguna dapat memulai ulang operasi menggunakan bidang continuation_token AzureError jika token tersedia.
set_http_headers
Menyetel properti sistem pada file atau direktori.
Jika satu properti diatur untuk content_settings, semua properti akan ditimpa.
set_http_headers(content_settings: ContentSettings | None = None, **kwargs) -> Dict[str, Any]
Parameter
- content_settings
- ContentSettings
Objek ContentSettings yang digunakan untuk mengatur properti file/direktori.
- lease
- DataLakeLeaseClient atau str
Jika ditentukan, set_file_system_metadata hanya berhasil jika sewa sistem file aktif dan cocok dengan ID ini.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
dict properti yang diperbarui file/direktori (Etag dan terakhir dimodifikasi)
Tipe hasil
set_metadata
Mengatur satu atau beberapa pasangan nilai nama yang ditentukan pengguna untuk sistem file yang ditentukan. Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang terlampir pada sistem file. Untuk menghapus semua metadata dari sistem file, panggil operasi ini tanpa dict metadata.
set_metadata(metadata: Dict[str, str], **kwargs) -> Dict[str, str | datetime]
Parameter
Dict yang berisi pasangan nama-nilai untuk dikaitkan dengan sistem file sebagai metadata. Contoh: {'category':'test'}
- lease
- DataLakeLeaseClient atau str
Jika ditentukan, set_file_system_metadata hanya berhasil jika sewa sistem file aktif dan cocok dengan ID ini.
- if_modified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.
- if_unmodified_since
- datetime
Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.
- etag
- str
Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .
- match_condition
- MatchConditions
Kondisi kecocokan untuk digunakan pada etag.
Mengenkripsi data di sisi layanan dengan kunci yang diberikan. Penggunaan kunci yang disediakan pelanggan harus dilakukan melalui HTTPS.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
dict properti yang diperbarui sistem file (Etag dan terakhir dimodifikasi).
update_access_control_recursive
Memodifikasi Access Control pada jalur dan sub-jalur.
update_access_control_recursive(acl: str, **kwargs: Any) -> AccessControlChangeResult
Parameter
- acl
- str
Memodifikasi hak kontrol akses POSIX pada file dan direktori. Nilai adalah daftar entri kontrol akses yang dipisahkan koma. Setiap entri kontrol akses (ACE) terdiri dari cakupan, jenis, pengidentifikasi pengguna atau grup, dan izin dalam format "[scope:][type]:[id]:[permissions]".
- progress_hook
- <xref:func>(AccessControlChanges)
Panggilan balik tempat pemanggil dapat melacak kemajuan operasi serta mengumpulkan jalur yang gagal diubah Access Control.
- continuation_token
- str
Token kelanjutan opsional yang dapat digunakan untuk melanjutkan operasi yang dihentikan sebelumnya.
- batch_size
- int
Pilihan. Jika ukuran himpunan data melebihi ukuran batch, maka operasi akan dibagi menjadi beberapa permintaan sehingga kemajuan dapat dilacak. Ukuran batch harus antara 1 dan 2000. Default saat tidak ditentukan adalah 2000.
- max_batches
- int
Pilihan. Menentukan jumlah maksimum batch yang dapat dijalankan oleh operasi Access Control perubahan tunggal. Jika maksimum tercapai sebelum semua sub-jalur diproses, maka token kelanjutan dapat digunakan untuk melanjutkan operasi. Nilai kosong menunjukkan bahwa jumlah maksimum batch dalam unbound dan operasi berlanjut hingga akhir.
- continue_on_failure
- bool
Jika diatur ke False, operasi akan berakhir dengan cepat saat mengalami kesalahan pengguna (4XX). Jika True, operasi akan mengabaikan kesalahan pengguna dan melanjutkan operasi pada sub-entitas lain dari direktori. Token kelanjutan hanya akan dikembalikan ketika continue_on_failure True jika terjadi kesalahan pengguna. Jika tidak diatur, nilai defaultnya adalah False untuk ini.
- timeout
- int
Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Ringkasan operasi rekursif, termasuk jumlah keberhasilan dan kegagalan, serta token kelanjutan jika operasi dihentikan sebelum waktunya.
Tipe hasil
Pengecualian
Pengguna dapat memulai ulang operasi menggunakan bidang continuation_token AzureError jika token tersedia.
Atribut
api_version
Versi STORAGE API yang digunakan untuk permintaan.
location_mode
Mode lokasi yang saat ini digunakan klien.
Secara default ini akan menjadi "primer". Opsi termasuk "primer" dan "sekunder".
primary_endpoint
URL titik akhir utama lengkap.
primary_hostname
Nama host titik akhir utama.
secondary_endpoint
URL titik akhir sekunder penuh jika dikonfigurasi.
Jika tidak tersedia, ValueError akan dinaikkan. Untuk secara eksplisit menentukan nama host sekunder, gunakan argumen kata kunci secondary_hostname opsional pada instantiation.
Pengecualian
secondary_hostname
Nama host titik akhir sekunder.
Jika tidak tersedia, ini akan menjadi Tidak Ada. Untuk secara eksplisit menentukan nama host sekunder, gunakan argumen kata kunci secondary_hostname opsional pada instantiation.
url
URL titik akhir lengkap untuk entitas ini, termasuk token SAS jika digunakan.
Ini bisa berupa titik akhir utama, atau titik akhir sekunder tergantung pada saat ini location_mode. :returns: URL titik akhir penuh ke entitas ini, termasuk token SAS jika digunakan. :rtype: str
Azure SDK for Python
Saran dan Komentar
https://aka.ms/ContentUserFeedback.
Segera hadir: Sepanjang tahun 2024 kami akan menghentikan penggunaan GitHub Issues sebagai mekanisme umpan balik untuk konten dan menggantinya dengan sistem umpan balik baru. Untuk mengetahui informasi selengkapnya, lihat:Kirim dan lihat umpan balik untuk