Sdílet prostřednictvím

BlobLeaseClient Třída

  • Reference

Vytvoří nový Objekt BlobLeaseClient.

Tento klient poskytuje operace zapůjčení pro Objekt BlobClient nebo ContainerClient.

Dědičnost
builtins.object
BlobLeaseClient

Konstruktor

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

Parametry

client
BlobClient nebo ContainerClient
Vyžadováno

Klient objektu blob nebo kontejneru 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í.

Pokud kontejner nemá aktivní zapůjčení, služba Blob Service vytvoří zapůjčení kontejneru a vrátí nové ID zapůjčení.
break_lease

Pokud má kontejner nebo objekt blob aktivní zapůjčení, přerušte zapůjčení.

Jakmile je zapůjčení přerušeno, není možné ho obnovit. 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í. Když je zapůjčení přerušené, může uplynout období přerušení zapůjčení, během kterého se u kontejneru nebo objektu blob nedají provádět žádné operace zapůjčení s výjimkou pozastavení a uvolnění. 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ěňte ID zapůjčení aktivního zapůjčení.
release

Uvolněte zapůjčení.

Zapůjčení může být uvolněno, pokud zadané ID zapůjčení klienta odpovídá ID přidruženému ke kontejneru nebo objektu blob. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení kontejneru nebo objektu blob, jakmile se vydání dokončí.
renew

Prodlouží zapůjčení.

Zapůjčení je možné prodloužit, pokud ID zapůjčení zadané v klientovi zapůjčení odpovídá ID přidružené ke kontejneru nebo objektu blob. Mějte na paměti, že zapůjčení může být obnoveno i v případě, že vypršela jeho platnost, pokud se kontejner nebo objekt blob od vypršení jeho platnosti znovu nepronajal. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení.

acquire

Požádá o nové zapůjčení.

Pokud kontejner nemá aktivní zapůjčení, služba Blob Service vytvoří zapůjčení kontejneru a vrátí nové ID zapůjčení.

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

Parametry

lease_duration
int
Vyžadováno

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k akci podle podmínky určené parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se použije u značky etag.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.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-blob-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

Pokud má kontejner nebo objekt blob aktivní zapůjčení, přerušte zapůjčení.

Jakmile je zapůjčení přerušeno, není možné ho obnovit. 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í. Když je zapůjčení přerušené, může uplynout období přerušení zapůjčení, během kterého se u kontejneru nebo objektu blob nedají provádět žádné operace zapůjčení s výjimkou pozastavení a uvolnění. 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(lease_break_period: int | None = None, **kwargs: Any) -> int

Parametry

lease_break_period
int
Vyžadováno

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

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.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-blob-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ěňte ID zapůjčení aktivního zapůjčení.

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 Pokud navrhované ID zapůjčení není ve správném formátu, vrátí služba Blob Service hodnotu 400 (neplatný požadavek).

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k akci podle podmínky určené parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se použije u značky etag.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.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-blob-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ěte zapůjčení.

Zapůjčení může být uvolněno, pokud zadané ID zapůjčení klienta odpovídá ID přidruženému ke kontejneru nebo objektu blob. Uvolnění zapůjčení umožní jinému klientovi okamžitě získat zapůjčení kontejneru nebo objektu blob, jakmile se vydání dokončí.

release(**kwargs: Any) -> None

Parametry

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k akci podle podmínky určené parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se použije u značky etag.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.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-blob-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í.

Zapůjčení je možné prodloužit, pokud ID zapůjčení zadané v klientovi zapůjčení odpovídá ID přidružené ke kontejneru nebo objektu blob. Mějte na paměti, že zapůjčení může být obnoveno i v případě, že vypršela jeho platnost, pokud se kontejner nebo objekt blob od vypršení jeho platnosti znovu nepronajal. Při obnovení zapůjčení se resetují hodiny doby trvání zapůjčení.

renew(**kwargs: Any) -> None

Parametry

if_modified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že se prostředek od zadaného času změnil.

if_unmodified_since
datetime

Hodnota DateTime. Azure očekává, že předaná hodnota data bude UTC. Pokud je zahrnuté časové pásmo, všechny hodnoty datetime mimo UTC se převedou na UTC. Pokud je datum předáno bez informací o časovém pásmu, předpokládá se, že je to UTC. Tuto hlavičku zadejte, pokud chcete operaci provést pouze v případě, že prostředek nebyl od zadaného data a času změněn.

etag
str

Hodnota ETag nebo zástupný znak (*). Slouží ke kontrole, jestli se prostředek změnil, a k akci podle podmínky určené parametrem match_condition .

match_condition
MatchConditions

Podmínka shody, která se použije u značky etag.

if_tags_match_condition
str

Zadejte klauzuli WHERE SQL pro značky objektů blob, která bude fungovat pouze s objektem blob s odpovídající hodnotou. např. "\"tagname\"='my tag'"

Novinka ve verzi 12.4.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-blob-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é