Bagikan melalui

BlobLeaseClient Kelas

  • Referensi

Membuat BlobLeaseClient baru.

Klien ini menyediakan operasi sewa pada BlobClient atau ContainerClient.

Warisan
builtins.object
BlobLeaseClient

Konstruktor

BlobLeaseClient(client: BlobClient | ContainerClient, lease_id: str | None = None)

Parameter

client
BlobClient atau ContainerClient
Diperlukan

Klien blob atau kontainer 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 yang saat ini 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.

Jika kontainer tidak memiliki sewa aktif, blob service membuat sewa pada kontainer dan mengembalikan ID sewa baru.
break_lease

Putuskan sewa, jika kontainer atau blob memiliki sewa aktif.

Setelah sewa rusak, sewa tidak dapat diperpanjang. Setiap permintaan yang diotorisasi dapat memutus sewa; permintaan tidak diperlukan untuk menentukan ID sewa yang cocok. Ketika sewa rusak, periode jeda sewa diizinkan untuk berlalu, selama waktu tersebut tidak ada operasi sewa kecuali pemutusan dan pelepasan dapat dilakukan pada kontainer atau blob. Ketika sewa berhasil rusak, respons menunjukkan interval dalam hitungan detik sampai sewa baru dapat diperoleh.
change

Ubah ID sewa sewa aktif.
release

Lepaskan sewanya.

Sewa dapat dirilis jika id sewa klien yang ditentukan cocok dengan yang terkait dengan kontainer atau blob. Melepaskan sewa memungkinkan klien lain untuk segera memperoleh sewa untuk kontainer atau blob segera setelah rilis selesai.
renew

Memperbarui sewa.

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

acquire

Meminta sewa baru.

Jika kontainer tidak memiliki sewa aktif, blob service membuat sewa pada kontainer dan mengembalikan ID sewa baru.

acquire(lease_duration: int = -1, **kwargs: Any) -> None

Parameter

lease_duration
int
Diperlukan

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

if_modified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.

if_unmodified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum diubah sejak tanggal/waktu yang ditentukan.

etag
str

Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .

match_condition
MatchConditions

Kondisi kecocokan untuk digunakan pada etag.

if_tags_match_condition
str

Tentukan SQL di mana klausa pada tag blob hanya beroperasi pada blob dengan nilai yang cocok. misalnya. "\"tagname\"='my tag'"

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

Putuskan sewa, jika kontainer atau blob memiliki sewa aktif.

Setelah sewa rusak, sewa tidak dapat diperpanjang. Setiap permintaan yang diotorisasi dapat memutus sewa; permintaan tidak diperlukan untuk menentukan ID sewa yang cocok. Ketika sewa rusak, periode jeda sewa diizinkan untuk berlalu, selama waktu tersebut tidak ada operasi sewa kecuali pemutusan dan pelepasan dapat dilakukan pada kontainer atau blob. Ketika sewa berhasil rusak, respons menunjukkan interval dalam hitungan detik sampai sewa baru dapat diperoleh.

break_lease(lease_break_period: int | None = None, **kwargs: Any) -> int

Parameter

lease_break_period
int
Diperlukan

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

if_modified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.

if_unmodified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum diubah sejak tanggal/waktu yang ditentukan.

if_tags_match_condition
str

Tentukan SQL di mana klausa pada tag blob hanya beroperasi pada blob dengan nilai yang cocok. misalnya. "\"tagname\"='my tag'"

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

Ubah ID sewa sewa aktif.

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

Parameter

proposed_lease_id
str
Diperlukan

ID sewa yang diusulkan, dalam format string GUID. Blob service mengembalikan 400 (Permintaan tidak valid) jika ID sewa yang diusulkan tidak dalam format yang benar.

if_modified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.

if_unmodified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum diubah sejak tanggal/waktu yang ditentukan.

etag
str

Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .

match_condition
MatchConditions

Kondisi kecocokan untuk digunakan pada etag.

if_tags_match_condition
str

Tentukan SQL di mana klausa pada tag blob hanya beroperasi pada blob dengan nilai yang cocok. misalnya. "\"tagname\"='my tag'"

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

Mengembalikan

Tidak ada

release

Lepaskan sewanya.

Sewa dapat dirilis jika id sewa klien yang ditentukan cocok dengan yang terkait dengan kontainer atau blob. Melepaskan sewa memungkinkan klien lain untuk segera memperoleh sewa untuk kontainer atau blob segera setelah rilis selesai.

release(**kwargs: Any) -> None

Parameter

if_modified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.

if_unmodified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum diubah sejak tanggal/waktu yang ditentukan.

etag
str

Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .

match_condition
MatchConditions

Kondisi kecocokan untuk digunakan pada etag.

if_tags_match_condition
str

Tentukan SQL di mana klausa pada tag blob hanya beroperasi pada blob dengan nilai yang cocok. misalnya. "\"tagname\"='my tag'"

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

Mengembalikan

Tidak ada

renew

Memperbarui sewa.

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

renew(**kwargs: Any) -> None

Parameter

if_modified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya telah dimodifikasi sejak waktu yang ditentukan.

if_unmodified_since
datetime

Nilai TanggalWaktu. Azure mengharapkan nilai tanggal yang diteruskan menjadi UTC. Jika zona waktu disertakan, tanggalwaktu non-UTC apa pun akan dikonversi ke UTC. Jika tanggal diteruskan tanpa info zona waktu, diasumsikan sebagai UTC. Tentukan header ini untuk melakukan operasi hanya jika sumber daya belum dimodifikasi sejak tanggal/waktu yang ditentukan.

etag
str

Nilai ETag, atau karakter kartubebas (*). Digunakan untuk memeriksa apakah sumber daya telah berubah, dan bertindak sesuai dengan kondisi yang ditentukan oleh parameter match_condition .

match_condition
MatchConditions

Kondisi kecocokan untuk digunakan pada etag.

if_tags_match_condition
str

Tentukan SQL di mana klausul pada tag blob hanya beroperasi pada blob dengan nilai yang cocok. misalnya. "\"tagname\"='my tag'"

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

Mengembalikan

Tidak ada