ShareLeaseClient Třída

Vytvoří nový ShareLeaseClient.

Tento klient poskytuje operace zapůjčení pro ShareClient nebo ShareFileClient.

Dědičnost

builtins.object

ShareLeaseClient

Konstruktor

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

Parametry

client

ShareFileClient nebo ShareClient

Vyžadováno

Klient souboru nebo sdílené složky k zapůjčení.

lease_id

str

výchozí hodnota: None

Řetězec představující ID zapůjčení existujícího zapůjčení. Tuto hodnotu není nutné zadávat, chcete-li získat nové zapůjčení nebo ji přerušit.

Proměnné

id

str

ID zapůjčení, které se právě udržuje. Pokud ještě nebylo získáno žádné zapůjčení, bude to Žádné .

etag

str

Značka ETag aktuálně udržovaného zapůjčení Pokud ještě nebylo získáno nebo změněno žádné zapůjčení, bude hodnota Žádné .

last_modified

datetime

Časové razítko poslední změny zapůjčení, které se právě udržuje. Pokud ještě nebylo získáno nebo změněno žádné zapůjčení, bude hodnota Žádné .

Metody

acquire	Požádá o nové zapůjčení. Tato operace vytvoří a spravuje zámek souboru nebo sdílené složky pro operace zápisu a odstranění. Pokud soubor nebo sdílená složka nemá aktivní zapůjčení, služba Soubor nebo sdílená složka vytvoří zapůjčení souboru nebo sdílené složky. Pokud má soubor aktivní zapůjčení, můžete o nové zapůjčení požádat pouze pomocí ID aktivního zapůjčení. Pokud soubor nebo sdílená složka nemá aktivní zapůjčení, služba Soubor nebo sdílená složka vytvoří zapůjčení souboru a vrátí nové ID zapůjčení.
break_lease	Vynutit přerušení zapůjčení, pokud má soubor nebo sdílená složka aktivní zapůjčení. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Nekonečné zapůjčení se okamžitě přeruší. Jakmile je zapůjčení přerušeno, není možné ho změnit. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Pokud se zapůjčení úspěšně přeruší, odpověď indikuje interval v sekundách, než bude možné získat nové zapůjčení.
change	Změní ID zapůjčení aktivního zapůjčení. Změna musí zahrnovat aktuální ID zapůjčení v x-ms-lease-id a nové ID zapůjčení v x-ms-proposed-lease-id.
release	Uvolní zapůjčení. Zapůjčení může být uvolněno, pokud ID zapůjčení zadané v žádosti odpovídá ID přidruženému ke sdílené složce nebo souboru. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení sdílené složky nebo souboru, jakmile se vydání dokončí.
renew	Prodlouží zapůjčení sdílené složky. Zapůjčení sdílené složky je možné prodloužit, pokud ID zapůjčení zadané v klientovi zapůjčení odpovídá ID přidružené ke sdílené složce. Mějte na paměti, že zapůjčení může být prodlouženo i v případě, že jeho platnost vypršela, pokud od vypršení platnosti zapůjčení nedošlo k opětovnému zapůjčení. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení. Novinka ve verzi 12.6.0.

acquire

Požádá o nové zapůjčení. Tato operace vytvoří a spravuje zámek souboru nebo sdílené složky pro operace zápisu a odstranění. Pokud soubor nebo sdílená složka nemá aktivní zapůjčení, služba Soubor nebo sdílená složka vytvoří zapůjčení souboru nebo sdílené složky. Pokud má soubor aktivní zapůjčení, můžete o nové zapůjčení požádat pouze pomocí ID aktivního zapůjčení.

Pokud soubor nebo sdílená složka nemá aktivní zapůjčení, služba Soubor nebo sdílená složka vytvoří zapůjčení souboru a vrátí nové ID zapůjčení.

acquire(**kwargs: Any) -> None

Parametry

lease_duration

int

Určuje dobu zapůjčení v sekundách nebo zápornou dobu (-1) pro zapůjčení, jehož platnost nikdy nevyprší. Zapůjčení souborů nikdy nevyprší. Nenekonečná zapůjčení sdílené složky může být mezi 15 a 60 sekund. Dobu trvání zapůjčení sdílené složky není možné změnit obnovením nebo změnou. Výchozí hodnota je -1 (nekonečné zapůjčení sdílené složky).

timeout

int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návratový typ

None

break_lease

Vynutit přerušení zapůjčení, pokud má soubor nebo sdílená složka aktivní zapůjčení. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Nekonečné zapůjčení se okamžitě přeruší.

Jakmile je zapůjčení přerušeno, není možné ho změnit. Jakákoli autorizovaná žádost může přerušit zapůjčení; požadavek není nutný k zadání odpovídajícího ID zapůjčení. Pokud se zapůjčení úspěšně přeruší, odpověď indikuje interval v sekundách, než bude možné získat nové zapůjčení.

break_lease(**kwargs: Any) -> int

Parametry

lease_break_period

int

Jedná se o navrženou dobu v sekundách, po kterou by zapůjčení sdílené složky mělo pokračovat, než se přeruší, a to od 0 do 60 sekund. Toto období přerušení se použije jenom v případě, že je kratší než zbývající doba zapůjčení sdílené složky. Pokud je delší, použije se zbývající čas zapůjčení sdílené složky. Zapůjčení nové sdílené složky nebude k dispozici před uplynutím doby pozastavení, ale zapůjčení sdílené složky může být drženo déle, než je doba přerušení. Pokud se tato hlavička nezobrazí u operace přerušení, zapůjčení sdílené složky s pevnou dobou trvání se po uplynutí doby zapůjčení zbývající sdílené složky přeruší a nekonečné zapůjčení sdílené složky se okamžitě přeruší.

Novinka ve verzi 12.6.0.

timeout

int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Přibližný zbývající čas v období zapůjčení (v sekundách).

Návratový typ

int

change

Změní ID zapůjčení aktivního zapůjčení. Změna musí zahrnovat aktuální ID zapůjčení v x-ms-lease-id a nové ID zapůjčení v x-ms-proposed-lease-id.

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

Parametry

proposed_lease_id

str

Vyžadováno

Navrhované ID zapůjčení ve formátu řetězce GUID Služba Soubor nebo sdílená složka vyvolá chybu (neplatný požadavek), pokud navrhované ID zapůjčení není ve správném formátu.

timeout

int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Žádné

release

Uvolní zapůjčení. Zapůjčení může být uvolněno, pokud ID zapůjčení zadané v žádosti odpovídá ID přidruženému ke sdílené složce nebo souboru. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení sdílené složky nebo souboru, jakmile se vydání dokončí.

release(**kwargs: Any) -> None

Parametry

timeout

int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Žádné

renew

Prodlouží zapůjčení sdílené složky.

Zapůjčení sdílené složky je možné prodloužit, pokud ID zapůjčení zadané v klientovi zapůjčení odpovídá ID přidružené ke sdílené složce. Mějte na paměti, že zapůjčení může být prodlouženo i v případě, že jeho platnost vypršela, pokud od vypršení platnosti zapůjčení nedošlo k opětovnému zapůjčení. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení.

Novinka ve verzi 12.6.0.

renew(**kwargs: Any) -> None

Parametry

timeout

int

Nastaví časový limit operace na straně serveru v sekundách. Další podrobnosti najdete tady: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-file-service-operations. Tato hodnota se v klientovi nesleduje ani neověřuje. Informace o konfiguraci časových limitů sítě na straně klienta najdete tady.

Návraty

Žádné