ShareLeaseClient Sınıf

Yeni bir ShareLeaseClient oluşturur.

Bu istemci bir ShareClient veya ShareFileClient üzerinde kiralama işlemleri sağlar.

Devralma

builtins.object

ShareLeaseClient

Oluşturucu

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

Parametreler

client

ShareFileClient veya ShareClient

Gerekli

Kiralamak için dosyanın veya paylaşımın istemcisi.

lease_id

str

varsayılan değer: None

Var olan bir kiranın kira kimliğini temsil eden dize. Yeni bir kira almak veya bir kirayı kesmek için bu değerin belirtilmesi gerekmez.

Değişkenler

id

str

Şu anda korunmakta olan kiranın kimliği. Henüz kira alınmadıysa, bu Hiçbiri olur.

etag

str

Şu anda sürdürülmekte olan kiralamanın ETag'i. Henüz kira alınmadıysa veya değiştirilmediyse, bu Hiçbiri olur.

last_modified

datetime

Şu anda devam etmekte olan kiranın son değiştirilen zaman damgası. Henüz kira alınmadıysa veya değiştirilmediyse, bu Hiçbiri olur.

Yöntemler

acquire	Yeni bir kira isteğinde bulunur. Bu işlem, yazma ve silme işlemleri için bir dosya veya paylaşım üzerinde kilit oluşturur ve yönetir. Dosya veya paylaşımın etkin bir kirası yoksa, Dosya veya Paylaş hizmeti dosya veya paylaşımda bir kiralama oluşturur. Dosyanın etkin kirası varsa, yalnızca etkin kira kimliğini kullanarak yeni kiralama isteyebilirsiniz. Dosya veya paylaşımın etkin kirası yoksa, Dosya veya Paylaş hizmeti dosya üzerinde bir kira oluşturur ve yeni bir kira kimliği döndürür.
break_lease	Dosya veya paylaşımın etkin bir kirası varsa zorlama işlemi kirayı bozar. Herhangi bir yetkili istek kirayı bozabilir; eşleşen bir kira kimliği belirtmek için istek gerekli değildir. Sonsuz kiralama anında bozulur. Kira bozulursa değiştirilemez. Herhangi bir yetkili istek kirayı bozabilir; eşleşen bir kira kimliği belirtmek için istek gerekli değildir. Kira başarıyla kesildiğinde, yanıt yeni bir kira alınıncaya kadar saniye cinsinden aralığı gösterir.
change	Etkin kiralamanın kira kimliğini değiştirir. Bir değişiklik, x-ms-lease-id içindeki geçerli kira kimliğini ve x-ms-proposed-lease-id içinde yeni bir kira kimliğini içermelidir.
release	Kirayı serbest bırakır. İstekte belirtilen kira kimliği, paylaşım veya dosyayla ilişkilendirilmiş olanla eşleşiyorsa kira serbest bırakılabilir. Kiranın serbest bırakılması, yayın tamamlandıktan hemen sonra başka bir istemcinin paylaşım veya dosya kirasını hemen almasını sağlar.
renew	Paylaşım kirasını yeniler. Kira istemcisinde belirtilen kira kimliği paylaşımla ilişkili olanla eşleşiyorsa, paylaşım kiralaması yenilenebilir. Kira süresi dolduğundan bu yana paylaşımın yeniden kiralanmadığı sürece süresi dolmuş olsa bile kiranın yenilenebileceğini unutmayın. Kiralamayı yenilediğinizde, kira süresi saati sıfırlanır. Sürüm 12.6.0'da yeni.

acquire

Yeni bir kira isteğinde bulunur. Bu işlem, yazma ve silme işlemleri için bir dosya veya paylaşım üzerinde kilit oluşturur ve yönetir. Dosya veya paylaşımın etkin bir kirası yoksa, Dosya veya Paylaş hizmeti dosya veya paylaşımda bir kiralama oluşturur. Dosyanın etkin kirası varsa, yalnızca etkin kira kimliğini kullanarak yeni kiralama isteyebilirsiniz.

Dosya veya paylaşımın etkin kirası yoksa, Dosya veya Paylaş hizmeti dosya üzerinde bir kira oluşturur ve yeni bir kira kimliği döndürür.

acquire(**kwargs: Any) -> None

Parametreler

lease_duration

int

Süresi hiç dolmamış bir kiralama için kiranın süresini saniye cinsinden veya negatif bir (-1) olarak belirtir. Dosya kiralamalarının süresi hiçbir zaman dolmaz. Sonsuz olmayan bir paylaşım kiralaması 15 ile 60 saniye arasında olabilir. Paylaşım kiralama süresi yenileme veya değişiklik kullanılarak değiştirilemez. Varsayılan değer -1 'dir (sonsuz paylaşım kiralaması).

timeout

int

İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Dönüş türü

None

break_lease

Dosya veya paylaşımın etkin bir kirası varsa zorlama işlemi kirayı bozar. Herhangi bir yetkili istek kirayı bozabilir; eşleşen bir kira kimliği belirtmek için istek gerekli değildir. Sonsuz kiralama anında bozulur.

Kira bozulursa değiştirilemez. Herhangi bir yetkili istek kirayı bozabilir; eşleşen bir kira kimliği belirtmek için istek gerekli değildir. Kira başarıyla kesildiğinde, yanıt yeni bir kira alınıncaya kadar saniye cinsinden aralığı gösterir.

break_lease(**kwargs: Any) -> int

Parametreler

lease_break_period

int

Bu, paylaşım kiralamasının bozulmadan önce 0 ile 60 saniye arasında devam etmesi için önerilen saniye süresidir. Bu kesme dönemi yalnızca paylaşım kirasının kalan süresinden kısaysa kullanılır. Daha uzunsa, paylaşım kiralamada kalan süre kullanılır. Kesme süresi dolmadan önce yeni bir paylaşım kiralaması kullanılamaz, ancak paylaşım kiralaması kesme döneminden daha uzun süre tutulabilir. Bu üst bilgi kesme işlemiyle birlikte görünmüyorsa, kalan paylaşım kiralama süresi geçtikten sonra sabit süreli paylaşım kiralaması bozulur ve sonsuz paylaşım kiralaması hemen sona erer.

Sürüm 12.6.0'da yeni.

timeout

int

İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

Kira döneminde kalan yaklaşık süre (saniye cinsinden).

Dönüş türü

int

change

Etkin kiralamanın kira kimliğini değiştirir. Bir değişiklik, x-ms-lease-id içindeki geçerli kira kimliğini ve x-ms-proposed-lease-id içinde yeni bir kira kimliğini içermelidir.

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

Parametreler

proposed_lease_id

str

Gerekli

GUID dizesi biçiminde önerilen kira kimliği. Önerilen kira kimliği doğru biçimde değilse Dosya veya Paylaş hizmeti hata (Geçersiz istek) oluşturur.

timeout

int

İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

Hiçbiri

release

Kirayı serbest bırakır. İstekte belirtilen kira kimliği, paylaşım veya dosyayla ilişkilendirilmiş olanla eşleşiyorsa kira serbest bırakılabilir. Kiranın serbest bırakılması, yayın tamamlandıktan hemen sonra başka bir istemcinin paylaşım veya dosya kirasını hemen almasını sağlar.

release(**kwargs: Any) -> None

Parametreler

timeout

int

İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

Hiçbiri

renew

Paylaşım kirasını yeniler.

Kira istemcisinde belirtilen kira kimliği paylaşımla ilişkili olanla eşleşiyorsa, paylaşım kiralaması yenilenebilir. Kira süresi dolduğundan bu yana paylaşımın yeniden kiralanmadığı sürece süresi dolmuş olsa bile kiranın yenilenebileceğini unutmayın. Kiralamayı yenilediğinizde, kira süresi saati sıfırlanır.

Sürüm 12.6.0'da yeni.

renew(**kwargs: Any) -> None

Parametreler

timeout

int

İşlemin sunucu tarafı zaman aşımını saniye olarak ayarlar. Diğer ayrıntılar için bkz: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Bu değer istemcide izlenmiyor veya doğrulanmıyor. İstemci tarafı ağ zaman aşımlarını yapılandırmak için buraya bakın.

Döndürülenler

Hiçbiri