Bagikan melalui

ShareDirectoryClient Kelas

  • Referensi

Klien untuk berinteraksi dengan direktori tertentu, meskipun mungkin belum ada.

Untuk operasi yang berkaitan dengan subdirektori atau file tertentu dalam berbagi ini, klien untuk entitas tersebut get_subdirectory_client juga dapat diambil menggunakan fungsi dan get_file_client .

Untuk konfigurasi opsional lainnya, silakan klik di sini.

Warisan
azure.storage.fileshare._shared.base_client.StorageAccountHostsMixin
ShareDirectoryClient

Konstruktor

ShareDirectoryClient(account_url: str, share_name: str, directory_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
Diperlukan

URI ke akun penyimpanan. Untuk membuat klien yang diberikan URI lengkap ke direktori, gunakan from_directory_url classmethod.

share_name
str
Diperlukan

Nama berbagi untuk direktori.

directory_path
str
Diperlukan

Jalur direktori untuk direktori yang akan berinteraksi. Jika ditentukan, nilai ini akan menggantikan nilai direktori yang ditentukan dalam URL direktori.

snapshot
str
nilai default: None

Rekam jepret berbagi opsional untuk dioperasikan. Ini bisa menjadi string ID rekam jepret atau respons yang dikembalikan dari create_snapshot.

credential
nilai default: None

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

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_directory

Membuat direktori baru di bawah direktori yang direferensikan oleh klien.
create_subdirectory

Membuat subdirektori baru dan mengembalikan klien untuk berinteraksi dengan subdirektori.
delete_directory

Menandai direktori untuk dihapus. Direktori kemudian dihapus selama pengumpulan sampah.
delete_file

Menandai file yang ditentukan untuk dihapus. File kemudian dihapus selama pengumpulan sampah.
delete_subdirectory

Menghapus subdirektori.
exists

Mengembalikan True jika ada direktori dan mengembalikan False jika tidak.
from_connection_string

Buat ShareDirectoryClient dari String Koneksi.
from_directory_url

Buat ShareDirectoryClient dari url direktori.
get_directory_properties

Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk direktori yang ditentukan. Data yang dikembalikan tidak menyertakan daftar file direktori.
get_file_client

Mendapatkan klien untuk berinteraksi dengan file tertentu.

File belum ada.
get_subdirectory_client

Dapatkan klien untuk berinteraksi dengan subdirektori tertentu.

Subdirektori belum ada.
list_directories_and_files

Mencantumkan semua direktori dan file di bawah direktori.
list_handles

Mencantumkan handel yang dibuka pada direktori atau file di bawah direktori.
rename_directory

Ganti nama direktori sumber.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes atau str :keyword file_creation_time:

Waktu pembuatan untuk direktori.

: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 direktori. 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'.
set_directory_metadata

Mengatur metadata untuk direktori.

Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang dilampirkan ke direktori. Untuk menghapus semua metadata dari direktori, panggil operasi ini dengan dict metadata kosong.
set_http_headers

Mengatur header HTTP pada direktori.
upload_file

Membuat file baru di direktori dan mengembalikan ShareFileClient untuk berinteraksi dengan file.

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(recursive: bool = False, **kwargs: Any) -> Dict[str, int]

Parameter

recursive
bool
Diperlukan

Boolean yang menentukan apakah operasi harus berlaku untuk direktori yang ditentukan oleh klien, filenya, subdirektorinya, dan filenya. Nilai defaultnya adalah Salah.

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

dict[str, int]

close_handle

Tutup handel file yang terbuka.

close_handle(handle: str | Handle, **kwargs: Any) -> Dict[str, int]

Parameter

handle
str atau Handle
Diperlukan

Handel tertentu untuk ditutup.

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

dict[str, int]

create_directory

Membuat direktori baru di bawah direktori yang direferensikan oleh klien.

create_directory(**kwargs: Any) -> Dict[str, Any]

Parameter

file_attributes
NTFSAttributes

Atribut sistem file untuk file dan direktori. Jika tidak diatur, nilai default akan menjadi "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.

file_creation_time
str atau datetime

Waktu pembuatan untuk direktori. Nilai default: "sekarang".

file_last_write_time
str atau datetime

Waktu tulis terakhir untuk direktori. Nilai default: "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 file-permission-key akan digunakan. Nilai default: Warisi. Jika SDDL ditentukan sebagai input, SDDL harus memiliki pemilik, grup, dan dacl. Catatan: Hanya salah satu izin file atau file-permission-key yang harus ditentukan.

file_permission_key
str

Kunci izin yang akan diatur untuk direktori/file. Catatan: Hanya salah satu izin file atau file-permission-key yang harus ditentukan.

file_change_time
str atau datetime

Ubah waktu untuk direktori. 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'.

metadata
dict(str,str)

Pasangan nama-nilai yang terkait dengan direktori sebagai metadata.

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 direktori (Etag dan terakhir dimodifikasi).

Tipe hasil

dict(str, Any)

Contoh

Membuat direktori.


   my_directory.create_directory()

create_subdirectory

Membuat subdirektori baru dan mengembalikan klien untuk berinteraksi dengan subdirektori.

create_subdirectory(directory_name: str, **kwargs) -> ShareDirectoryClient

Parameter

directory_name
str
Diperlukan

Nama subdirektori.

metadata
dict(str,str)

Pasangan nama-nilai yang terkait dengan subdirektori sebagai metadata.

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

ShareDirectoryClient

Tipe hasil

ShareDirectoryClient

Contoh

Buat subdirektori.


   # Create the directory
   parent_dir.create_directory()

   # Create a subdirectory
   subdir = parent_dir.create_subdirectory("subdir")

delete_directory

Menandai direktori untuk dihapus. Direktori kemudian dihapus selama pengumpulan sampah.

delete_directory(**kwargs: Any) -> None

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.

Tipe hasil

None

Contoh

Menghapus direktori.


   my_directory.delete_directory()

delete_file

Menandai file yang ditentukan untuk dihapus. File kemudian dihapus selama pengumpulan sampah.

delete_file(file_name: str, **kwargs: Any | None) -> None

Parameter

file_name
str
Diperlukan

Nama file yang akan dihapus.

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

None

Contoh

Menghapus file dalam direktori.


   # Delete the file in the directory
   my_directory.delete_file(file_name="sample")

delete_subdirectory

Menghapus subdirektori.

delete_subdirectory(directory_name: str, **kwargs) -> None

Parameter

directory_name
str
Diperlukan

Nama subdirektori.

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

None

Contoh

Menghapus subdirektori.


   parent_dir.delete_subdirectory("subdir")

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-file-service-operations. Nilai ini tidak dilacak atau divalidasi pada klien. Untuk mengonfigurasi batas waktu jaringan sisi klien, lihat di sini.

Mengembalikan

Benar jika direktori ada, Salah jika tidak.

Tipe hasil

bool

from_connection_string

Buat ShareDirectoryClient dari String Koneksi.

from_connection_string(conn_str: str, share_name: str, directory_path: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parameter

conn_str
str
Diperlukan

string koneksi ke akun Azure Storage.

share_name
str
Diperlukan

Nama berbagi.

directory_path
str
Diperlukan

Jalur direktori.

credential
nilai default: None

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.
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 direktori.

Tipe hasil

ShareDirectoryClient

from_directory_url

Buat ShareDirectoryClient dari url direktori.

from_directory_url(directory_url: str, snapshot: str | Dict[str, Any] | None = None, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parameter

directory_url
str
Diperlukan

URI lengkap ke direktori.

snapshot
str
nilai default: None

Rekam jepret berbagi opsional untuk dioperasikan. Ini bisa menjadi string ID rekam jepret atau respons yang dikembalikan dari create_snapshot.

credential
nilai default: None

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.
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 direktori.

Tipe hasil

ShareDirectoryClient

get_directory_properties

Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk direktori yang ditentukan. Data yang dikembalikan tidak menyertakan daftar file direktori.

get_directory_properties(**kwargs: Any) -> DirectoryProperties

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

DirectoryProperties

Tipe hasil

DirectoryProperties

get_file_client

Mendapatkan klien untuk berinteraksi dengan file tertentu.

File belum ada.

get_file_client(file_name: str, **kwargs: Any) -> ShareFileClient

Parameter

file_name
str
Diperlukan

Nama file.

Mengembalikan

Klien File.

Tipe hasil

ShareFileClient

get_subdirectory_client

Dapatkan klien untuk berinteraksi dengan subdirektori tertentu.

Subdirektori belum ada.

get_subdirectory_client(directory_name: str, **kwargs: Any) -> ShareDirectoryClient

Parameter

directory_name
str
Diperlukan

Nama subdirektori.

Mengembalikan

Klien Direktori.

Tipe hasil

ShareDirectoryClient

Contoh

Mendapatkan klien subdirektori.


   # Get a directory client and create the directory
   parent = share.get_directory_client("dir1")
   parent.create_directory()

   # Get a subdirectory client and create the subdirectory "dir1/dir2"
   subdirectory = parent.get_subdirectory_client("dir2")
   subdirectory.create_directory()

list_directories_and_files

Mencantumkan semua direktori dan file di bawah direktori.

list_directories_and_files(name_starts_with: str | None = None, **kwargs: Any) -> ItemPaged

Parameter

name_starts_with
str
Diperlukan

Memfilter hasil untuk mengembalikan hanya entitas yang namanya dimulai dengan awalan yang ditentukan.

include
list[str]

Sertakan parameter ini untuk menentukan satu atau beberapa himpunan data untuk disertakan dalam respons. Nilai str yang mungkin adalah "tanda waktu", "Etag", "Atribut", "PermissionKey".

Baru dalam versi 12.6.0.

Argumen kata kunci ini diperkenalkan dalam versi API '2020-10-02'.

include_extended_info
bool

Jika ini diatur ke true, id file akan dikembalikan dalam hasil yang tercantum.

Baru dalam versi 12.6.0.

Argumen kata kunci ini diperkenalkan dalam versi API '2020-10-02'.

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 DirectoryProperties dan FileProperties seperti dict

Tipe hasil

ItemPaged[DirectoryProperties <xref:and> FileProperties]

Contoh

Mencantumkan direktori dan file.


   # List the directories and files under the parent directory
   my_list = list(parent_dir.list_directories_and_files())
   print(my_list)

list_handles

Mencantumkan handel yang dibuka pada direktori atau file di bawah direktori.

list_handles(recursive: bool = False, **kwargs: Any) -> ItemPaged[Handle]

Parameter

recursive
bool
Diperlukan

Boolean yang menentukan apakah operasi harus berlaku untuk direktori yang ditentukan oleh klien, filenya, subdirektorinya, dan filenya. Nilai defaultnya adalah Salah.

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

ItemPaged[Handle]

rename_directory

Ganti nama direktori sumber.

:p aramtype file_attributes:~azure.storage.fileshare.NTFSAttributes atau str :keyword file_creation_time:

Waktu pembuatan untuk direktori.

: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 direktori. 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_directory(new_name: str, **kwargs: Any) -> ShareDirectoryClient

Parameter

metadata
Dict[str,str]

Pasangan nama-nilai untuk dikaitkan dengan objek penyimpanan file.

destination_lease
ShareLeaseClient atau str

Diperlukan jika file tujuan memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.

Mengembalikan

Klien Direktori baru.

Tipe hasil

ShareDirectoryClient

set_directory_metadata

Mengatur metadata untuk direktori.

Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang dilampirkan ke direktori. Untuk menghapus semua metadata dari direktori, panggil operasi ini dengan dict metadata kosong.

set_directory_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]

Parameter

metadata
dict(str, str)
Diperlukan

Pasangan nama-nilai yang terkait dengan direktori sebagai metadata.

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 direktori (Etag dan terakhir dimodifikasi).

Tipe hasil

dict(str, Any)

set_http_headers

Mengatur header HTTP pada direktori.

set_http_headers(file_attributes: str | NTFSAttributes = 'none', 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

file_attributes
NTFSAttributes
Diperlukan

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'

file_creation_time
str atau datetime
Diperlukan

Waktu pembuatan untuk nilai Default file: Pertahankan.

file_last_write_time
str atau datetime
Diperlukan

Waktu tulis terakhir untuk nilai Default file: Pertahankan.

file_permission
str
Diperlukan

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
Diperlukan

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.

file_change_time
str atau datetime

Ubah waktu untuk direktori. 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'.

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

dict(str, Any)

upload_file

Membuat file baru di direktori dan mengembalikan ShareFileClient untuk berinteraksi dengan file.

upload_file(file_name: str, data: bytes | str | Iterable | IO, length: int | None = None, **kwargs) -> ShareFileClient

Parameter

file_name
str
Diperlukan

Nama file.

data
Diperlukan

Konten file.

length
int
Diperlukan

Panjang file dalam byte. Tentukan ukuran maksimumnya, hingga 1 TiB.

metadata
dict(str,str)

Pasangan nama-nilai yang terkait dengan file sebagai metadata.

content_settings
ContentSettings

Objek ContentSettings yang digunakan untuk mengatur properti file. Digunakan untuk mengatur tipe konten, pengodean, bahasa, disposisi, md5, dan kontrol cache.

validate_content
bool

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 bitflips 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

Jumlah maksimum koneksi paralel yang akan digunakan.

progress_hook
Callable[[int, Optional[int]], None]

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 total adalah ukuran blob atau Tidak Ada jika ukurannya tidak diketahui.

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.

encoding
str

Default ke UTF-8.

Mengembalikan

ShareFileClient

Tipe hasil

ShareFileClient

Contoh

Unggah file ke direktori.


   # Upload a file to the directory
   with open(SOURCE_FILE, "rb") as source:
       my_directory.upload_file(file_name="sample", data=source)

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

ValueError

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