ShareLeaseClient Kelas

Membuat ShareLeaseClient baru.

Klien ini menyediakan operasi sewa pada ShareClient atau ShareFileClient.

Warisan

builtins.object

ShareLeaseClient

Konstruktor

ShareLeaseClient(client: ShareFileClient | ShareClient, lease_id: str | None = None)

Parameter

client

ShareFileClient atau ShareClient

Diperlukan

Klien file atau berbagi untuk disewakan.

lease_id

str

nilai default: None

String yang mewakili ID sewa dari sewa yang ada. Nilai ini tidak perlu ditentukan untuk memperoleh sewa baru, atau memutusnya.

Variabel

id

str

ID sewa saat ini sedang dipertahankan. Ini akan menjadi Tidak Ada jika belum ada sewa yang diperoleh.

etag

str

ETag sewa saat ini sedang dipertahankan. Ini akan menjadi Tidak Ada jika belum ada sewa yang diperoleh atau dimodifikasi.

last_modified

datetime

Tanda waktu terakhir yang dimodifikasi dari sewa yang saat ini sedang dipertahankan. Ini akan menjadi Tidak Ada jika belum ada sewa yang diperoleh atau dimodifikasi.

Metode

acquire	Meminta sewa baru. Operasi ini menetapkan dan mengelola kunci pada file atau berbagi untuk operasi tulis dan hapus. Jika file atau berbagi tidak memiliki sewa aktif, layanan File atau Berbagi membuat sewa pada file atau berbagi. Jika file memiliki sewa aktif, Anda hanya dapat meminta sewa baru menggunakan ID sewa aktif. Jika file atau berbagi tidak memiliki sewa aktif, layanan File atau Berbagi membuat sewa pada file dan mengembalikan ID sewa baru.
break_lease	Paksa memutuskan sewa jika file atau berbagi memiliki sewa aktif. Setiap permintaan yang diotorisasi dapat memutus sewa; permintaan tidak diperlukan untuk menentukan ID sewa yang cocok. Sewa tak terbatas segera berhenti. Setelah sewa rusak, sewa tidak dapat diubah. Setiap permintaan yang diotorisasi dapat memutus sewa; permintaan tidak diperlukan untuk menentukan ID sewa yang cocok. Ketika sewa berhasil rusak, respons menunjukkan interval dalam hitungan detik sampai sewa baru dapat diperoleh.
change	Mengubah ID sewa sewa aktif. Perubahan harus mencakup ID sewa saat ini dalam x-ms-lease-id dan ID sewa baru di x-ms-proposed-lease-id.
release	Melepaskan sewa. Sewa dapat dirilis jika ID sewa yang ditentukan pada permintaan cocok dengan yang terkait dengan berbagi atau file. Melepaskan sewa memungkinkan klien lain untuk segera memperoleh sewa untuk berbagi atau file segera setelah rilis selesai.
renew	Memperpanjang sewa berbagi. Sewa berbagi dapat diperpanjang jika ID sewa yang ditentukan dalam klien sewa cocok dengan yang terkait dengan berbagi. Perhatikan bahwa sewa dapat diperpanjang bahkan jika telah kedaluwarsa selama berbagi belum disewakan lagi sejak kedaluwarsa sewa tersebut. Saat Anda memperbarui sewa, jam durasi sewa direset. Baru dalam versi 12.6.0.

acquire

Meminta sewa baru. Operasi ini menetapkan dan mengelola kunci pada file atau berbagi untuk operasi tulis dan hapus. Jika file atau berbagi tidak memiliki sewa aktif, layanan File atau Berbagi membuat sewa pada file atau berbagi. Jika file memiliki sewa aktif, Anda hanya dapat meminta sewa baru menggunakan ID sewa aktif.

Jika file atau berbagi tidak memiliki sewa aktif, layanan File atau Berbagi membuat sewa pada file dan mengembalikan ID sewa baru.

acquire(**kwargs: Any) -> None

Parameter

lease_duration

int

Menentukan durasi sewa, dalam detik, atau negatif satu (-1) untuk sewa yang tidak pernah kedaluwarsa. Sewa file tidak pernah kedaluwarsa. Sewa berbagi yang tidak terbatas bisa antara 15 dan 60 detik. Durasi sewa berbagi tidak dapat diubah menggunakan pembaruan atau perubahan. Defaultnya adalah -1 (sewa berbagi tak terbatas).

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

break_lease

Paksa memutuskan sewa jika file atau berbagi memiliki sewa aktif. Setiap permintaan yang diotorisasi dapat memutus sewa; permintaan tidak diperlukan untuk menentukan ID sewa yang cocok. Sewa tak terbatas segera berhenti.

Setelah sewa rusak, sewa tidak dapat diubah. Setiap permintaan yang diotorisasi dapat memutus sewa; permintaan tidak diperlukan untuk menentukan ID sewa yang cocok. Ketika sewa berhasil rusak, respons menunjukkan interval dalam hitungan detik sampai sewa baru dapat diperoleh.

break_lease(**kwargs: Any) -> int

Parameter

lease_break_period

int

Ini adalah durasi yang diusulkan dari detik bahwa sewa berbagi harus dilanjutkan sebelum rusak, antara 0 dan 60 detik. Periode jeda ini hanya digunakan jika lebih pendek dari waktu yang tersisa pada sewa berbagi. Jika lebih lama, waktu yang tersisa pada sewa berbagi digunakan. Sewa saham baru tidak akan tersedia sebelum periode istirahat berakhir, tetapi sewa saham dapat ditahan lebih lama dari periode istirahat. Jika header ini tidak muncul dengan operasi pemutusan, sewa berbagi durasi tetap akan berhenti setelah periode sewa berbagi yang tersisa berlalu, dan sewa berbagi tak terbatas segera berhenti.

Baru dalam versi 12.6.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

Perkiraan waktu yang tersisa dalam periode sewa, dalam detik.

Tipe hasil

int

change

Mengubah ID sewa sewa aktif. Perubahan harus mencakup ID sewa saat ini dalam x-ms-lease-id dan ID sewa baru di x-ms-proposed-lease-id.

change(proposed_lease_id: str, **kwargs: Any) -> None

Parameter

proposed_lease_id

str

Diperlukan

ID sewa yang diusulkan, dalam format string GUID. Layanan File atau Berbagi akan memunculkan kesalahan (Permintaan tidak valid) jika ID sewa yang diusulkan tidak dalam format yang benar.

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

Tidak ada

release

Melepaskan sewa. Sewa dapat dirilis jika ID sewa yang ditentukan pada permintaan cocok dengan yang terkait dengan berbagi atau file. Melepaskan sewa memungkinkan klien lain untuk segera memperoleh sewa untuk berbagi atau file segera setelah rilis selesai.

release(**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.

Mengembalikan

Tidak ada

renew

Memperpanjang sewa berbagi.

Sewa berbagi dapat diperpanjang jika ID sewa yang ditentukan dalam klien sewa cocok dengan yang terkait dengan berbagi. Perhatikan bahwa sewa dapat diperpanjang bahkan jika telah kedaluwarsa selama berbagi belum disewakan lagi sejak kedaluwarsa sewa tersebut. Saat Anda memperbarui sewa, jam durasi sewa direset.

Baru dalam versi 12.6.0.

renew(**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.

Mengembalikan

Tidak ada