ShareClient Kelas
Klien untuk berinteraksi dengan berbagi tertentu, meskipun berbagi tersebut mungkin belum ada.
Untuk operasi yang berkaitan dengan direktori atau file tertentu dalam berbagi ini, klien untuk entitas tersebut get_directory_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.StorageAccountHostsMixinShareClient
Konstruktor
ShareClient(account_url: str, share_name: 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 berbagi, gunakan from_share_url classmethod.
- snapshot
- str
Rekam jepret berbagi 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
.
Metode
acquire_lease |
Meminta sewa baru. Jika berbagi tidak memiliki sewa aktif, Layanan Berbagi membuat sewa pada berbagi dan mengembalikan sewa baru. Baru dalam versi 12.5.0. |
close |
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks. |
create_directory |
Membuat direktori di berbagi dan mengembalikan klien untuk berinteraksi dengan direktori. |
create_permission_for_share |
Buat izin (deskriptor keamanan) di tingkat berbagi. 'Izin' ini dapat digunakan untuk file/direktori dalam berbagi. Jika 'izin' sudah ada, itu akan mengembalikan kuncinya, jika tidak membuat izin baru di tingkat berbagi dan mengembalikan kuncinya. |
create_share |
Membuat Berbagi baru di bawah akun. Jika berbagi dengan nama yang sama sudah ada, operasi gagal. |
create_snapshot |
Membuat rekam jepret berbagi. Rekam jepret adalah versi baca-saja dari berbagi yang diambil pada titik waktu tertentu. Ini dapat dibaca, disalin, atau dihapus, tetapi tidak dimodifikasi. Rekam jepret menyediakan cara untuk mencadangkan berbagi seperti yang muncul pada suatu saat. Rekam jepret berbagi memiliki nama yang sama dengan berbagi dasar tempat rekam jepret diambil, dengan nilai DateTime ditambahkan untuk menunjukkan waktu pengambilan rekam jepret. |
delete_directory |
Menandai direktori untuk dihapus. Direktori kemudian dihapus selama pengumpulan sampah. |
delete_share |
Menandai berbagi yang ditentukan untuk dihapus. Berbagi kemudian dihapus selama pengumpulan sampah. |
from_connection_string |
Membuat ShareClient dari String Koneksi. |
from_share_url | |
get_directory_client |
Mendapatkan klien untuk berinteraksi dengan direktori yang ditentukan. Direktori belum ada. |
get_file_client |
Mendapatkan klien untuk berinteraksi dengan file yang ditentukan. File belum ada. |
get_permission_for_share |
Dapatkan izin (deskriptor keamanan) untuk kunci tertentu. 'Izin' ini dapat digunakan untuk file/direktori dalam berbagi. |
get_share_access_policy |
Mendapatkan izin untuk berbagi. Izin menunjukkan apakah file dalam berbagi dapat diakses secara publik. |
get_share_properties |
Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk berbagi yang ditentukan. Data yang dikembalikan tidak menyertakan daftar file atau direktori berbagi. |
get_share_stats |
Mendapatkan perkiraan ukuran data yang disimpan pada berbagi dalam byte. Perhatikan bahwa nilai ini mungkin tidak menyertakan semua file yang baru dibuat atau baru-baru ini diubah ukurannya. |
list_directories_and_files |
Mencantumkan direktori dan file di bawah berbagi. |
set_share_access_policy |
Mengatur izin untuk berbagi, atau kebijakan akses tersimpan yang dapat digunakan dengan Tanda Tangan Akses Bersama. Izin menunjukkan apakah file dalam berbagi dapat diakses secara publik. |
set_share_metadata |
Mengatur metadata untuk berbagi. Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang dilampirkan ke berbagi. Untuk menghapus semua metadata dari berbagi, panggil operasi ini tanpa dict metadata. |
set_share_properties |
Mengatur properti berbagi. Baru dalam versi 12.4.0. |
set_share_quota |
Mengatur kuota untuk berbagi. |
acquire_lease
Meminta sewa baru.
Jika berbagi tidak memiliki sewa aktif, Layanan Berbagi membuat sewa pada berbagi dan mengembalikan sewa baru.
Baru dalam versi 12.5.0.
acquire_lease(**kwargs: Any) -> ShareLeaseClient
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 Berbagi 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 atas saham.
share.create_directory("mydir")
lease = share.acquire_lease()
share.get_share_properties(lease=lease)
share.delete_share(lease=lease)
close
Metode ini untuk menutup soket yang dibuka oleh klien. Ini tidak perlu digunakan saat menggunakan dengan manajer konteks.
close()
create_directory
Membuat direktori di berbagi dan mengembalikan klien untuk berinteraksi dengan direktori.
create_directory(directory_name: str, **kwargs: Any) -> ShareDirectoryClient
Parameter
- metadata
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
ShareDirectoryClient
Tipe hasil
create_permission_for_share
Buat izin (deskriptor keamanan) di tingkat berbagi.
'Izin' ini dapat digunakan untuk file/direktori dalam berbagi. Jika 'izin' sudah ada, itu akan mengembalikan kuncinya, jika tidak membuat izin baru di tingkat berbagi dan mengembalikan kuncinya.
create_permission_for_share(file_permission: str, **kwargs: Any) -> str
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
Kunci izin file
Tipe hasil
create_share
Membuat Berbagi baru di bawah akun. Jika berbagi dengan nama yang sama sudah ada, operasi gagal.
create_share(**kwargs: Any) -> Dict[str, Any]
Parameter
- quota
- int
Kuota yang akan dialokasikan.
- access_tier
Menentukan tingkat akses berbagi. Nilai yang mungkin: 'TransactionOptimized', 'Hot', 'Cool'
- 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.
- protocols
- str atau ShareProtocols
Protokol untuk diaktifkan pada berbagi. Hanya satu protokol yang dapat diaktifkan pada berbagi.
- root_squash
- str atau ShareRootSquash
Root squash untuk diatur pada berbagi. Hanya berlaku untuk berbagi NFS. Nilai yang mungkin termasuk: 'NoRootSquash', 'RootSquash', 'AllSquash'.
Mengembalikan
Dict properti yang diperbarui berbagi (Etag dan terakhir dimodifikasi).
Tipe hasil
Contoh
Membuat berbagi file.
# Create share with Access Tier set to Hot
share.create_share(access_tier=ShareAccessTier("Hot"))
create_snapshot
Membuat rekam jepret berbagi.
Rekam jepret adalah versi baca-saja dari berbagi yang diambil pada titik waktu tertentu. Ini dapat dibaca, disalin, atau dihapus, tetapi tidak dimodifikasi. Rekam jepret menyediakan cara untuk mencadangkan berbagi seperti yang muncul pada suatu saat.
Rekam jepret berbagi memiliki nama yang sama dengan berbagi dasar tempat rekam jepret diambil, dengan nilai DateTime ditambahkan untuk menunjukkan waktu pengambilan rekam jepret.
create_snapshot(**kwargs: Any | None) -> Dict[str, Any]
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
Dict properti yang diperbarui berbagi (ID Rekam Jepret, Etag, dan terakhir dimodifikasi).
Tipe hasil
Contoh
Membuat rekam jepret dari berbagi file.
share.create_snapshot()
delete_directory
Menandai direktori untuk dihapus. Direktori kemudian dihapus selama pengumpulan sampah.
delete_directory(directory_name: str, **kwargs: Any) -> None
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.
Tipe hasil
delete_share
Menandai berbagi yang ditentukan untuk dihapus. Berbagi kemudian dihapus selama pengumpulan sampah.
delete_share(delete_snapshots: bool | None = False, **kwargs) -> None
Parameter
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.5.0.
Argumen kata kunci ini diperkenalkan dalam versi API '2020-08-04'.
- 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.
Contoh
Menghapus berbagi dan rekam jepret apa pun.
share.delete_share(delete_snapshots=True)
from_connection_string
Membuat ShareClient dari String Koneksi.
from_connection_string(conn_str: str, share_name: 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 berbagi 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.
Mengembalikan
Klien berbagi.
Tipe hasil
Contoh
Mendapatkan klien berbagi dari string koneksi.
from azure.storage.fileshare import ShareClient
share = ShareClient.from_connection_string(self.connection_string, "sharesamples2")
from_share_url
from_share_url(share_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 berbagi 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.
Mengembalikan
Klien berbagi.
Tipe hasil
get_directory_client
Mendapatkan klien untuk berinteraksi dengan direktori yang ditentukan. Direktori belum ada.
get_directory_client(directory_path: str | None = None) -> ShareDirectoryClient
Parameter
Mengembalikan
Klien Direktori.
Tipe hasil
get_file_client
Mendapatkan klien untuk berinteraksi dengan file yang ditentukan. File belum ada.
get_file_client(file_path: str) -> ShareFileClient
Parameter
Mengembalikan
Klien File.
Tipe hasil
get_permission_for_share
Dapatkan izin (deskriptor keamanan) untuk kunci tertentu.
'Izin' ini dapat digunakan untuk file/direktori dalam berbagi.
get_permission_for_share(permission_key: str, **kwargs: Any) -> str
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
Izin file (SDDL portabel)
Tipe hasil
get_share_access_policy
Mendapatkan izin untuk berbagi. Izin menunjukkan apakah file dalam berbagi dapat diakses secara publik.
get_share_access_policy(**kwargs: Any) -> Dict[str, Any]
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.
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.5.0.
Argumen kata kunci ini diperkenalkan dalam versi API '2020-08-04'.
Mengembalikan
Mengakses informasi kebijakan dalam dict.
Tipe hasil
get_share_properties
Mengembalikan semua metadata dan properti sistem yang ditentukan pengguna untuk berbagi yang ditentukan. Data yang dikembalikan tidak menyertakan daftar file atau direktori berbagi.
get_share_properties(**kwargs: Any) -> ShareProperties
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.
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.5.0.
Argumen kata kunci ini diperkenalkan dalam versi API '2020-08-04'.
Mengembalikan
Properti berbagi.
Tipe hasil
Contoh
Mendapatkan properti berbagi.
properties = share.get_share_properties()
get_share_stats
Mendapatkan perkiraan ukuran data yang disimpan pada berbagi dalam byte.
Perhatikan bahwa nilai ini mungkin tidak menyertakan semua file yang baru dibuat atau baru-baru ini diubah ukurannya.
get_share_stats(**kwargs: Any) -> 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.
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.5.0.
Argumen kata kunci ini diperkenalkan dalam versi API '2020-08-04'.
Mengembalikan
Perkiraan ukuran data (dalam byte) yang disimpan di berbagi.
Tipe hasil
list_directories_and_files
Mencantumkan direktori dan file di bawah berbagi.
list_directories_and_files(directory_name: str | None = None, name_starts_with: str | None = None, marker: str | None = None, **kwargs: Any) -> Iterable[Dict[str, str]]
Parameter
- name_starts_with
- str
Memfilter hasil untuk mengembalikan hanya direktori yang namanya dimulai dengan awalan yang ditentukan.
- marker
- str
Token kelanjutan buram. Nilai ini dapat diambil dari bidang next_marker dari objek generator sebelumnya. Jika ditentukan, generator ini akan mulai mengembalikan hasil dari titik ini.
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
Contoh
Mencantumkan direktori dan file dalam berbagi.
# Create a directory in the share
dir_client = share.create_directory("mydir")
# Upload a file to the directory
with open(SOURCE_FILE, "rb") as source_file:
dir_client.upload_file(file_name="sample", data=source_file)
# List files in the directory
my_files = list(share.list_directories_and_files(directory_name="mydir"))
print(my_files)
set_share_access_policy
Mengatur izin untuk berbagi, atau kebijakan akses tersimpan yang dapat digunakan dengan Tanda Tangan Akses Bersama. Izin menunjukkan apakah file dalam berbagi dapat diakses secara publik.
set_share_access_policy(signed_identifiers: Dict[str, AccessPolicy], **kwargs: Any) -> Dict[str, str]
Parameter
- signed_identifiers
- dict(str, AccessPolicy)
Kamus kebijakan akses untuk dikaitkan dengan berbagi. Kamus mungkin berisi hingga 5 elemen. Kamus kosong akan menghapus kebijakan akses yang ditetapkan pada layanan.
- 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.
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.5.0.
Argumen kata kunci ini diperkenalkan dalam versi API '2020-08-04'.
Mengembalikan
Dict properti yang diperbarui berbagi (Etag dan terakhir dimodifikasi).
Tipe hasil
set_share_metadata
Mengatur metadata untuk berbagi.
Setiap panggilan ke operasi ini menggantikan semua metadata yang ada yang dilampirkan ke berbagi. Untuk menghapus semua metadata dari berbagi, panggil operasi ini tanpa dict metadata.
set_share_metadata(metadata: Dict[str, Any], **kwargs: Any) -> Dict[str, Any]
Parameter
Pasangan nama-nilai yang terkait dengan berbagi sebagai metadata.
- 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.
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.5.0.
Argumen kata kunci ini diperkenalkan dalam versi API '2020-08-04'.
Mengembalikan
Dict properti yang diperbarui berbagi (Etag dan terakhir dimodifikasi).
Tipe hasil
Contoh
Mengatur metadata berbagi.
data = {'category': 'test'}
share.set_share_metadata(metadata=data)
set_share_properties
Mengatur properti berbagi.
Baru dalam versi 12.4.0.
set_share_properties(**kwargs: Any) -> Dict[str, Any]
Parameter
- access_tier
- str atau <xref:azure.storage.fileshare.models.ShareAccessTier>
Menentukan tingkat akses berbagi. Nilai yang mungkin: 'TransactionOptimized', 'Hot', dan 'Cool'
- quota
- int
Menentukan ukuran maksimum berbagi, dalam gigabyte. Harus lebih besar dari 0, dan kurang dari atau sama dengan 5TB.
- 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.
- root_squash
- str atau ShareRootSquash
Root squash untuk diatur pada berbagi. Hanya berlaku untuk berbagi NFS. Nilai yang mungkin termasuk: 'NoRootSquash', 'RootSquash', 'AllSquash'.
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Mengembalikan
Dict properti yang diperbarui berbagi (Etag dan terakhir dimodifikasi).
Tipe hasil
Contoh
Mengatur properti berbagi.
# Set the tier for the first share to Hot
share1.set_share_properties(access_tier="Hot")
# Set the quota for the first share to 3
share1.set_share_properties(quota=3)
# Set the tier for the second share to Cool and quota to 2
share2.set_share_properties(access_tier=ShareAccessTier("Cool"), quota=2)
# Get the shares' properties
print(share1.get_share_properties().access_tier)
print(share1.get_share_properties().quota)
print(share2.get_share_properties().access_tier)
print(share2.get_share_properties().quota)
set_share_quota
Mengatur kuota untuk berbagi.
set_share_quota(quota: int, **kwargs: Any) -> Dict[str, Any]
Parameter
- quota
- int
Menentukan ukuran maksimum berbagi, dalam gigabyte. Harus lebih besar dari 0, dan kurang dari atau sama dengan 5TB.
- 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.
- lease
Diperlukan jika berbagi memiliki sewa aktif. Nilai dapat menjadi objek ShareLeaseClient atau ID sewa sebagai string.
Baru dalam versi 12.5.0.
Argumen kata kunci ini diperkenalkan dalam versi API '2020-08-04'.
Mengembalikan
Dict properti yang diperbarui berbagi (Etag dan terakhir dimodifikasi).
Tipe hasil
Contoh
Mengatur kuota berbagi.
# Set the quota for the share to 1GB
share.set_share_quota(quota=1)
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