ShareFileClient Kelas
Klien untuk berinteraksi dengan file tertentu, meskipun file tersebut mungkin belum ada.
Untuk konfigurasi opsional lainnya, silakan klik di sini.
- Warisan
-
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixinShareFileClient
Konstruktor
ShareFileClient(account_url: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, *, token_intent: Literal['backup'] | None = None, **kwargs: Any)
Parameter
- account_url
- str
URI ke akun penyimpanan. Untuk membuat klien yang diberikan URI lengkap ke file, gunakan from_file_url classmethod.
- file_path
- str
Jalur file ke file untuk berinteraksi. Jika ditentukan, nilai ini akan menggantikan nilai file yang ditentukan dalam URL file.
- snapshot
- str
Rekam jepret file opsional untuk dioperasikan. Ini bisa menjadi string ID rekam jepret atau respons yang dikembalikan dari create_snapshot.
- 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.
- token_intent
- Literal['backup']
Diperlukan saat menggunakan TokenCredential untuk autentikasi dan diabaikan untuk bentuk autentikasi lainnya. Menentukan niat untuk semua permintaan saat menggunakan autentikasi TokenCredential . Potensi nilai:
pencadangan - Menentukan permintaan ditujukan untuk operasi jenis pencadangan/admin, yang berarti bahwa semua ACL file/direktori dilewati dan izin penuh diberikan. Pengguna juga harus memiliki izin RBAC yang diperlukan.
- allow_trailing_dot
- bool
Jika true, titik berikutnya tidak akan dipangkas dari URI target.
- allow_source_trailing_dot
- bool
Jika true, titik berikutnya tidak akan dipangkas dari URI sumber.
- 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.
Baru dalam versi 12.1.0.
- secondary_hostname
- str
Nama host titik akhir sekunder.
- max_range_size
- int
Ukuran rentang maksimum yang digunakan untuk unggahan file. Default ke 4*1024*1024
.
- audience
- str
Audiens yang digunakan saat meminta token untuk autentikasi Azure Active Directory. Hanya memiliki efek ketika kredensial berjenis TokenCredential. Nilainya bisa ( https://storage.azure.com/ default) atau https://.file.core.windows.net.
Metode
abort_copy |
Membatalkan operasi penyalinan yang sedang berlangsung. Ini akan meninggalkan file tujuan dengan panjang nol dan metadata penuh. Ini akan menimbulkan kesalahan jika operasi salin telah berakhir. |
acquire_lease |
Meminta sewa baru. Jika file tidak memiliki sewa aktif, Layanan File membuat sewa pada blob dan mengembalikan sewa baru. |
clear_range |
Menghapus rentang yang ditentukan dan melepaskan ruang yang digunakan dalam penyimpanan untuk rentang tersebut. |
close |
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks. |
close_all_handles |
Tutup handel file yang terbuka. Operasi ini akan memblokir hingga layanan menutup semua handel terbuka. |
close_handle |
Tutup handel file yang terbuka. |
create_file |
Membuat file baru. Perhatikan bahwa file hanya menginisialisasi file tanpa konten. |
delete_file |
Menandai file yang ditentukan untuk dihapus. File kemudian dihapus selama pengumpulan sampah. |
download_file |
Mengunduh file ke StorageStreamDownloader. Metode readall() harus digunakan untuk membaca semua konten atau readinto() harus digunakan untuk mengunduh file ke dalam aliran. Menggunakan chunks() mengembalikan iterator yang memungkinkan pengguna untuk melakukan iterasi atas konten dalam gugus. |
from_connection_string |
Buat ShareFileClient dari String Koneksi. |
from_file_url |
Klien untuk berinteraksi dengan file tertentu, meskipun file tersebut mungkin belum ada. |
get_file_properties |
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk file tersebut. |
get_ranges |
Mengembalikan daftar rentang halaman yang valid untuk file atau rekam jepret file. |
get_ranges_diff |
Mengembalikan daftar rentang halaman yang valid untuk file atau rekam jepret file. Baru dalam versi 12.6.0. |
list_handles |
Mencantumkan handel untuk file. |
rename_file |
Ganti nama file sumber. :p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes atau str :keyword file_creation_time: Waktu pembuatan untuk file. :p aramtype file_creation_time:~datetime.datetime atau str :keyword file_last_write_time: Waktu penulisan terakhir untuk file. :p aramtype file_last_write_time:~datetime.datetime atau str :keyword file_change_time: Ubah waktu untuk file. Jika tidak ditentukan, waktu perubahan akan diatur ke tanggal/waktu saat ini. Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'. |
resize_file |
Mengubah ukuran file ke ukuran yang ditentukan. |
set_file_metadata |
Mengatur metadata yang ditentukan pengguna untuk file yang ditentukan sebagai satu atau beberapa pasangan nama-nilai. Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang dilampirkan ke file. Untuk menghapus semua metadata dari file, panggil operasi ini tanpa dict metadata. |
set_http_headers |
Mengatur header HTTP pada file. |
start_copy_from_url |
Memulai penyalinan data dari URL sumber ke dalam file yang dirujuk oleh klien. Status operasi penyalinan ini dapat ditemukan menggunakan metode get_properties . |
upload_file |
Mengunggah file baru. data param: Konten file. panjang int param: Panjang file dalam byte. Tentukan ukuran maksimumnya, hingga 1 TiB. param file_attributes: Atribut sistem file untuk file dan direktori. Jika tidak diatur, nilai defaultnya adalah "Tidak Ada" dan atribut akan diatur ke "Arsip". Berikut adalah contoh ketika jenis var adalah str: 'Temporary|Arsip'. nilai file_attributes tidak peka huruf besar/kecil. ketik file_attributes: str atau ~azure.storage.fileshare.NTFSAttributes param file_creation_time: Waktu pembuatan untuk nilai Default file: Sekarang. ketik file_creation_time: str atau ~datetime.datetime param file_last_write_time: Waktu penulisan terakhir untuk nilai Default file: Sekarang. ketik file_last_write_time: str atau ~datetime.datetime param file_permission: Jika ditentukan, izin (pendeskripsi keamanan) harus diatur untuk direktori/file. Header ini dapat digunakan jika Ukuran izin adalah <= 8KB, atau header x-ms-file-permission-key harus digunakan. Nilai default: Warisi. Jika SDDL ditentukan sebagai input, SDDL harus memiliki pemilik, grup, dan dacl. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan. type file_permission: str param permission_key: Kunci izin yang akan diatur untuk direktori/file. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan. jenis permission_key: str |
upload_range |
Unggah rentang byte ke file. |
upload_range_from_url |
Menulis byte dari satu titik akhir Azure File ke dalam rentang titik akhir Azure File lain yang ditentukan. |
abort_copy
Membatalkan operasi penyalinan yang sedang berlangsung.
Ini akan meninggalkan file tujuan dengan panjang nol dan metadata penuh. Ini akan menimbulkan kesalahan jika operasi salin telah berakhir.
abort_copy(copy_id: str | FileProperties, **kwargs: Any) -> None
Parameter
- copy_id
- str atau FileProperties
Operasi salin untuk membatalkan. Ini bisa berupa ID, atau instans FileProperties.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Tipe hasil
acquire_lease
Meminta sewa baru.
Jika file tidak memiliki sewa aktif, Layanan File membuat sewa pada blob dan mengembalikan sewa baru.
acquire_lease(lease_id: str | None = None, **kwargs: Any) -> ShareLeaseClient
Parameter
- lease_id
- str
ID sewa yang diusulkan, dalam format string GUID. Layanan File mengembalikan 400 (Permintaan tidak valid) jika ID sewa yang diusulkan tidak dalam format yang benar.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Objek ShareLeaseClient.
Tipe hasil
Contoh
Memperoleh sewa pada file.
source_file.create_file(1024)
lease = source_file.acquire_lease()
source_file.upload_file(b'hello world', lease=lease)
lease.release()
clear_range
Menghapus rentang yang ditentukan dan melepaskan ruang yang digunakan dalam penyimpanan untuk rentang tersebut.
clear_range(offset: int, length: int, **kwargs) -> Dict[str, Any]
Parameter
- offset
- int
Mulai rentang byte yang digunakan untuk menghapus bagian file. Rentangnya bisa berukuran hingga 4 MB.
- length
- int
Jumlah byte yang digunakan untuk menghapus bagian file. Rentangnya bisa berukuran hingga 4 MB.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-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 (Etag dan terakhir dimodifikasi).
Tipe hasil
close
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks.
close()
close_all_handles
Tutup handel file yang terbuka.
Operasi ini akan memblokir hingga layanan menutup semua handel terbuka.
close_all_handles(**kwargs: Any) -> Dict[str, int]
Parameter
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Jumlah handel ditutup (ini mungkin 0 jika handel yang ditentukan tidak ditemukan) dan jumlah handel gagal ditutup dalam dict.
Tipe hasil
close_handle
Tutup handel file yang terbuka.
close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]
Parameter
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Jumlah handel ditutup (ini mungkin 0 jika handel yang ditentukan tidak ditemukan) dan jumlah handel gagal ditutup dalam dict.
Tipe hasil
create_file
Membuat file baru.
Perhatikan bahwa file hanya menginisialisasi file tanpa konten.
create_file(size: int, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]
Parameter
- file_attributes
- NTFSAttributes
Atribut sistem file untuk file dan direktori. Jika tidak diatur, nilai defaultnya adalah "Tidak Ada" dan atribut akan diatur ke "Arsip". Berikut adalah contoh ketika jenis var adalah str: 'Temporary|Arsip'. nilai file_attributes tidak peka huruf besar/kecil.
Waktu tulis terakhir untuk nilai Default file: Sekarang.
- file_permission
- str
Jika ditentukan, izin (pendeskripsi keamanan) akan diatur untuk direktori/file. Header ini dapat digunakan jika Ukuran izin adalah <= 8KB, atau header x-ms-file-permission-key akan digunakan. Nilai default: Warisi. Jika SDDL ditentukan sebagai input, SDDL harus memiliki pemilik, grup, dan dacl. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan.
- permission_key
- str
Kunci izin yang akan diatur untuk direktori/file. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan.
Ubah waktu untuk file. Jika tidak ditentukan, waktu perubahan akan diatur ke tanggal/waktu saat ini.
Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
- content_settings
- ContentSettings
Objek ContentSettings yang digunakan untuk mengatur properti file. Digunakan untuk mengatur tipe konten, pengodean, bahasa, disposisi, md5, dan kontrol cache.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-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 (Etag dan terakhir dimodifikasi).
Tipe hasil
Contoh
Buat file.
# Create and allocate bytes for the file (no content added yet)
my_allocated_file.create_file(size=100)
delete_file
Menandai file yang ditentukan untuk dihapus. File kemudian dihapus selama pengumpulan sampah.
delete_file(**kwargs: Any) -> None
Parameter
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Tipe hasil
Contoh
Menghapus file.
my_file.delete_file()
download_file
Mengunduh file ke StorageStreamDownloader. Metode readall() harus digunakan untuk membaca semua konten atau readinto() harus digunakan untuk mengunduh file ke dalam aliran. Menggunakan chunks() mengembalikan iterator yang memungkinkan pengguna untuk melakukan iterasi atas konten dalam gugus.
download_file(offset: int | None = None, length: int | None = None, **kwargs: Any) -> StorageStreamDownloader
Parameter
- offset
- int
Mulai rentang byte yang digunakan untuk mengunduh bagian file. Harus diatur jika panjang disediakan.
- length
- int
Jumlah byte yang akan dibaca dari aliran. Ini bersifat opsional, tetapi harus disediakan untuk performa yang optimal.
- max_concurrency
- int
Jumlah maksimum koneksi paralel yang akan digunakan.
- validate_content
- bool
Jika true, menghitung hash MD5 untuk setiap gugus file. Layanan penyimpanan memeriksa hash konten yang telah tiba dengan hash yang dikirim. Ini terutama berharga untuk mendeteksi bitflips pada kawat jika menggunakan http alih-alih https sebagai https (default) sudah akan memvalidasi. Perhatikan bahwa hash MD5 ini tidak disimpan dengan file . Perhatikan juga bahwa jika diaktifkan, algoritma pengunggahan yang hemat memori tidak akan digunakan, karena komputasi hash MD5 memerlukan buffering seluruh blok, dan melakukannya mengalahkan tujuan algoritma yang hemat memori.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
Panggilan balik untuk melacak kemajuan unduhan yang berjalan lama. Tanda tangan adalah fungsi (saat ini: int, total: int) di mana saat ini adalah jumlah byte yang ditransfer sejauh ini, dan total adalah ukuran total unduhan.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Objek streaming (StorageStreamDownloader)
Tipe hasil
Contoh
Unduh file.
with open(DEST_FILE, "wb") as data:
stream = my_file.download_file()
data.write(stream.readall())
from_connection_string
Buat ShareFileClient dari String Koneksi.
from_connection_string(conn_str: str, share_name: str, file_path: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parameter
- snapshot
- str
Rekam jepret file opsional untuk dioperasikan. Ini bisa menjadi string ID rekam jepret atau respons yang dikembalikan dari create_snapshot.
- 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.
- audience
- str
Audiens yang digunakan saat meminta token untuk autentikasi Azure Active Directory. Hanya memiliki efek ketika kredensial berjenis TokenCredential. Nilainya bisa ( https://storage.azure.com/ default) atau https://.file.core.windows.net.
Mengembalikan
Klien File.
Tipe hasil
Contoh
Membuat klien file dengan string koneksi.
from azure.storage.fileshare import ShareFileClient
file = ShareFileClient.from_connection_string(
self.connection_string,
share_name="helloworld2",
file_path="myfile")
from_file_url
Klien untuk berinteraksi dengan file tertentu, meskipun file tersebut mungkin belum ada.
from_file_url(file_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parameter
- snapshot
- str
Rekam jepret file opsional untuk dioperasikan. Ini bisa menjadi string ID rekam jepret atau respons yang dikembalikan dari create_snapshot.
- 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.
- audience
- str
Audiens yang digunakan saat meminta token untuk autentikasi Azure Active Directory. Hanya memiliki efek ketika kredensial berjenis TokenCredential. Nilainya bisa ( https://storage.azure.com/ default) atau https://.file.core.windows.net.
Mengembalikan
Klien File.
Tipe hasil
get_file_properties
Mengembalikan semua metadata yang ditentukan pengguna, properti HTTP standar, dan properti sistem untuk file tersebut.
get_file_properties(**kwargs: Any) -> FileProperties
Parameter
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
FileProperties
Tipe hasil
get_ranges
Mengembalikan daftar rentang halaman yang valid untuk file atau rekam jepret file.
get_ranges(offset: int | None = None, length: int | None = None, **kwargs: Any) -> List[Dict[str, int]]
Parameter
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Daftar rentang yang valid.
Tipe hasil
get_ranges_diff
Mengembalikan daftar rentang halaman yang valid untuk file atau rekam jepret file.
Baru dalam versi 12.6.0.
get_ranges_diff(previous_sharesnapshot: str | Dict[str, Any], offset: int | None = None, length: int | None = None, **kwargs: Any) -> Tuple[List[Dict[str, int]], List[Dict[str, int]]]
Parameter
- previous_sharesnapshot
- str
Parameter diff rekam jepret yang berisi nilai DateTime buram yang menentukan rekam jepret file sebelumnya untuk dibandingkan dengan rekam jepret yang lebih baru atau file saat ini.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Tupel dua daftar rentang file sebagai kamus dengan kunci 'start' dan 'end'. Elemen pertama adalah rentang file yang diisi, elemen ke-2 dibersihkan rentang file.
Tipe hasil
list_handles
Mencantumkan handel untuk file.
list_handles(**kwargs: Any) -> ItemPaged[Handle]
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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Mengembalikan
Halaman otomatis yang dapat diulang dari Handel
Tipe hasil
rename_file
Ganti nama file sumber.
:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes atau str :keyword file_creation_time:
Waktu pembuatan untuk file.
:p aramtype file_creation_time:~datetime.datetime atau str :keyword file_last_write_time:
Waktu penulisan terakhir untuk file.
:p aramtype file_last_write_time:~datetime.datetime atau str :keyword file_change_time:
Ubah waktu untuk file. Jika tidak ditentukan, waktu perubahan akan diatur ke tanggal/waktu saat ini.
Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
rename_file(new_name: str, **kwargs: Any) -> ShareFileClient
Parameter
- content_type
- str
Tipe Isi file baru.
Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
- source_lease
- ShareLeaseClient atau str
Diperlukan jika file sumber memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
- destination_lease
- ShareLeaseClient atau str
Diperlukan jika file tujuan memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Mengembalikan
Klien File baru.
Tipe hasil
resize_file
Mengubah ukuran file ke ukuran yang ditentukan.
resize_file(size: int, **kwargs: Any) -> Dict[str, Any]
Parameter
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-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 (Etag dan terakhir dimodifikasi).
Tipe hasil
set_file_metadata
Mengatur metadata yang ditentukan pengguna untuk file yang ditentukan sebagai satu atau beberapa pasangan nama-nilai.
Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang dilampirkan ke file. Untuk menghapus semua metadata dari file, panggil operasi ini tanpa dict metadata.
set_file_metadata(metadata: Dict[str, Any] | None = None, **kwargs: Any) -> Dict[str, Any]
Parameter
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-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 (Etag dan terakhir dimodifikasi).
Tipe hasil
set_http_headers
Mengatur header HTTP pada file.
set_http_headers(content_settings: ContentSettings, file_attributes: str | NTFSAttributes = 'preserve', file_creation_time: str | datetime | None = 'preserve', file_last_write_time: str | datetime | None = 'preserve', file_permission: str | None = None, permission_key: str | None = None, **kwargs: Any) -> Dict[str, Any]
Parameter
- content_settings
- ContentSettings
Objek ContentSettings yang digunakan untuk mengatur properti file. Digunakan untuk mengatur tipe konten, pengodean, bahasa, disposisi, md5, dan kontrol cache.
- file_attributes
- NTFSAttributes
Atribut sistem file untuk file dan direktori. Jika tidak diatur, menunjukkan pelestarian nilai yang ada. Berikut adalah contoh ketika jenis var adalah str: 'Temporary|Arsip'
Waktu pembuatan untuk nilai Default file: Pertahankan.
Waktu tulis terakhir untuk nilai Default file: Pertahankan.
- file_permission
- str
Jika ditentukan, izin (pendeskripsi keamanan) harus diatur untuk direktori/file. Header ini dapat digunakan jika Ukuran izin adalah <= 8KB, atau header x-ms-file-permission-key harus digunakan. Nilai default: Warisi. Jika SDDL ditentukan sebagai input, SDDL harus memiliki pemilik, grup, dan dacl. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan.
- permission_key
- str
Kunci izin yang akan diatur untuk direktori/file. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan.
Ubah waktu untuk file. Jika tidak ditentukan, waktu perubahan akan diatur ke tanggal/waktu saat ini.
Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-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 (Etag dan terakhir dimodifikasi).
Tipe hasil
start_copy_from_url
Memulai penyalinan data dari URL sumber ke dalam file yang dirujuk oleh klien.
Status operasi penyalinan ini dapat ditemukan menggunakan metode get_properties .
start_copy_from_url(source_url: str, **kwargs: Any) -> Any
Parameter
- file_permission
- str
Jika ditentukan, izin (pendeskripsi keamanan) harus diatur untuk direktori/file. Nilai ini dapat diatur ke "sumber" untuk menyalin deskriptor keamanan dari file sumber. Jika tidak, jika diatur, nilai ini akan digunakan untuk mengambil alih nilai sumber. Jika tidak diatur, nilai izin diwarisi dari direktori induk file target. Pengaturan ini dapat digunakan jika Ukuran izin = <8KB, jika tidak, permission_key akan digunakan. Jika SDDL ditentukan sebagai input, SDDL harus memiliki pemilik, grup, dan dacl. Catatan: Hanya salah satu file_permission atau permission_key yang harus ditentukan.
Baru dalam versi 12.1.0: Parameter ini diperkenalkan dalam versi API '2019-07-07'.
- permission_key
- str
Kunci izin yang akan diatur untuk direktori/file. Nilai ini dapat diatur ke "sumber" untuk menyalin deskriptor keamanan dari file sumber. Jika tidak, jika diatur, nilai ini akan digunakan untuk mengambil alih nilai sumber. Jika tidak diatur, nilai izin diwarisi dari direktori induk file target. Catatan: Hanya salah satu file_permission atau permission_key yang harus ditentukan.
Baru dalam versi 12.1.0: Parameter ini diperkenalkan dalam versi API '2019-07-07'.
- file_attributes
- NTFSAttributes
Nilai ini dapat diatur ke "sumber" untuk menyalin atribut file dari file sumber ke file target, atau untuk menghapus semua atribut, nilai tersebut dapat diatur ke "Tidak Ada". Jika tidak, itu dapat diatur ke daftar atribut untuk diatur pada file target. Jika ini tidak diatur, nilai defaultnya adalah "Arsip".
Baru dalam versi 12.1.0: Parameter ini diperkenalkan dalam versi API '2019-07-07'.
Nilai ini dapat diatur ke "sumber" untuk menyalin waktu pembuatan dari file sumber ke file target, atau tanggalwaktu untuk diatur sebagai waktu pembuatan pada file target. Ini juga bisa menjadi string dalam format ISO 8601. Jika ini tidak diatur, waktu pembuatan akan diatur ke nilai waktu tanggal pembuatan (atau ketika ditimpa) dari file target dengan mesin salin.
Baru dalam versi 12.1.0: Parameter ini diperkenalkan dalam versi API '2019-07-07'.
Nilai ini dapat diatur ke "sumber" untuk menyalin waktu tulis terakhir dari file sumber ke file target, atau tanggalwaktu untuk ditetapkan sebagai waktu tulis terakhir pada file target. Ini juga bisa menjadi string dalam format ISO 8601. Jika ini tidak diatur, nilai akan menjadi waktu tulis terakhir ke file oleh mesin salin.
Baru dalam versi 12.1.0: Parameter ini diperkenalkan dalam versi API '2019-07-07'.
Ubah waktu untuk file. Jika tidak ditentukan, waktu perubahan akan diatur ke tanggal/waktu saat ini.
Baru dalam versi 12.9.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
- ignore_read_only
- bool
Menentukan opsi untuk menimpa file target jika sudah ada dan memiliki set atribut baca-saja.
Baru dalam versi 12.1.0: Parameter ini diperkenalkan dalam versi API '2019-07-07'.
- set_archive_attribute
- bool
Menentukan opsi untuk mengatur atribut arsip pada file target. Benar berarti atribut arsip akan diatur pada file target meskipun atribut diganti atau status file sumber.
Baru dalam versi 12.1.0: Parameter ini diperkenalkan dalam versi API '2019-07-07'.
- metadata
Pasangan nama-nilai yang terkait dengan file sebagai metadata.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
Tipe hasil
Contoh
Menyalin file dari URL
destination_file.start_copy_from_url(source_url=source_url)
upload_file
Mengunggah file baru.
data param: Konten file.
panjang int param: Panjang file dalam byte. Tentukan ukuran maksimumnya, hingga 1 TiB.
param file_attributes: Atribut sistem file untuk file dan direktori. Jika tidak diatur, nilai defaultnya adalah "Tidak Ada" dan atribut akan diatur ke "Arsip". Berikut adalah contoh ketika jenis var adalah str: 'Temporary|Arsip'. nilai file_attributes tidak peka huruf besar/kecil.
ketik file_attributes: str atau ~azure.storage.fileshare.NTFSAttributes
param file_creation_time: Waktu pembuatan untuk nilai Default file: Sekarang.
ketik file_creation_time: str atau ~datetime.datetime
param file_last_write_time: Waktu penulisan terakhir untuk nilai Default file: Sekarang.
ketik file_last_write_time: str atau ~datetime.datetime
param file_permission: Jika ditentukan, izin (pendeskripsi keamanan) harus diatur untuk direktori/file. Header ini dapat digunakan jika Ukuran izin adalah <= 8KB, atau header x-ms-file-permission-key harus digunakan. Nilai default: Warisi. Jika SDDL ditentukan sebagai input, SDDL harus memiliki pemilik, grup, dan dacl. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan.
type file_permission: str
param permission_key: Kunci izin yang akan diatur untuk direktori/file. Catatan: Hanya salah satu x-ms-file-permission atau x-ms-file-permission-key yang harus ditentukan.
jenis permission_key: str
upload_file(data: bytes | str | Iterable | IO, length: int | None = None, file_attributes: str | NTFSAttributes = 'none', file_creation_time: str | datetime | None = 'now', file_last_write_time: str | datetime | None = 'now', file_permission: str | None = None, permission_key: str | None = None, **kwargs) -> Dict[str, Any]
Parameter
- file_change_time
Ubah waktu untuk file. Jika tidak ditentukan, waktu perubahan akan diatur ke tanggal/waktu saat ini.
Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
paramtype file_change_time: str atau ~datetime.datetime
metadata dict(str,str): Pasangan nilai nama yang terkait dengan file sebagai metadata.
kata kunci ~azure.storage.fileshare.ContentSettings content_settings: Objek ContentSettings yang digunakan untuk mengatur properti file. Digunakan untuk mengatur tipe konten, pengodean, bahasa, disposisi, md5, dan kontrol cache.
bool kata kunci validate_content: Jika true, menghitung hash MD5 untuk setiap rentang file. Layanan penyimpanan memeriksa hash konten yang telah tiba dengan hash yang dikirim. Ini terutama berharga untuk mendeteksi bitflip pada kawat jika menggunakan http alih-alih https sebagai https (default) sudah akan memvalidasi. Perhatikan bahwa hash MD5 ini tidak disimpan dengan file .
max_concurrency int kata kunci: Jumlah maksimum koneksi paralel yang akan digunakan.
sewa kata kunci: Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
sewa paramtype: ~azure.storage.fileshare.ShareLeaseClient atau str
kata kunci progress_hook: Panggilan balik untuk melacak kemajuan unggahan yang berjalan lama. Tanda tangan adalah fungsi(saat ini: int, total: Opsional[int]) di mana saat ini adalah jumlah byte yang ditransfer sejauh ini, dan totalnya adalah ukuran blob atau Tidak Ada jika ukurannya tidak diketahui.
paramtype progress_hook: Callable[[int, Optional[int]], None]
batas waktu int kata kunci: Mengatur batas waktu sisi server untuk operasi dalam hitung detik. Untuk detail selengkapnya, lihat https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
pengodean str kata kunci: Default ke UTF-8.
returns: Dict properti yang diperbarui file (Etag dan terakhir dimodifikasi).
rtype: dict(str, Any)
Contoh:Unggah file.
with open(SOURCE_FILE, "rb") as source:
my_file.upload_file(source)
upload_range
Unggah rentang byte ke file.
upload_range(data: bytes, offset: int, length: int, **kwargs) -> Dict[str, Any]
Parameter
- offset
- int
Mulai rentang byte yang digunakan untuk mengunggah bagian file. Rentangnya bisa berukuran hingga 4 MB.
- length
- int
Jumlah byte yang digunakan untuk mengunggah bagian file. Rentangnya bisa berukuran hingga 4 MB.
- validate_content
- bool
Jika true, menghitung hash MD5 dari konten halaman. Layanan penyimpanan memeriksa hash konten yang telah tiba dengan hash yang dikirim. Ini terutama berharga untuk mendeteksi bitflip pada kawat jika menggunakan http alih-alih https sebagai https (default) sudah akan memvalidasi. Perhatikan bahwa hash MD5 ini tidak disimpan dengan file .
- file_last_write_mode
- Literal["preserve", "now"]
Jika waktu penulisan terakhir file harus dipertahankan atau ditimpa. Nilai yang mungkin adalah "pertahankan" atau "sekarang". Jika tidak ditentukan, waktu penulisan terakhir file akan diubah ke tanggal/waktu saat ini.
Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
- encoding
- str
Default ke UTF-8.
Mengembalikan
Dict properti yang diperbarui file (Etag dan terakhir dimodifikasi).
Tipe hasil
upload_range_from_url
Menulis byte dari satu titik akhir Azure File ke dalam rentang titik akhir Azure File lain yang ditentukan.
upload_range_from_url(source_url: str, offset: int, length: int, source_offset: int, **kwargs: Any) -> Dict[str, Any]
Parameter
- offset
- int
Mulai rentang byte yang digunakan untuk memperbarui bagian file. Rentangnya bisa berukuran hingga 4 MB.
- length
- int
Jumlah byte yang digunakan untuk memperbarui bagian file. Rentangnya bisa berukuran hingga 4 MB.
- source_url
- str
URL dengan panjang hingga 2 KB yang menentukan file atau blob Azure. Nilai harus dikodekan URL karena akan muncul dalam URI permintaan. Jika sumber berada di akun lain, sumber harus bersifat publik atau harus diautentikasi melalui tanda tangan akses bersama. Jika sumbernya bersifat publik, tidak diperlukan autentikasi. Contoh: https://myaccount.file.core.windows.net/myshare/mydir/myfilehttps://otheraccount.file.core.windows.net/myshare/mydir/myfile?sastoken
- source_offset
- int
Ini menunjukkan dimulainya rentang byte (inklusif) yang harus diambil dari sumber salinan. Layanan akan membaca jumlah byte yang sama dengan rentang tujuan (offset panjang).
- 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 kondisional ini untuk menyalin blob hanya jika blob sumber telah dimodifikasi sejak tanggal/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 kondisional ini untuk menyalin blob hanya jika blob sumber 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.
- file_last_write_mode
- Literal["preserve", "now"]
Jika waktu penulisan terakhir file harus dipertahankan atau ditimpa. Nilai yang mungkin adalah "pertahankan" atau "sekarang". Jika tidak ditentukan, waktu penulisan terakhir file akan diubah ke tanggal/waktu saat ini.
Baru dalam versi 12.8.0: Parameter ini diperkenalkan dalam versi API '2021-06-08'.
- lease
- ShareLeaseClient atau str
Diperlukan jika file memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.1.0.
- 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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.
- source_authorization
- str
Autentikasi sebagai perwakilan layanan menggunakan rahasia klien untuk mengakses blob sumber. Pastikan "pembawa" adalah awalan dari string source_authorization.
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