Sdílet prostřednictvím

Vytváření a správa zapůjčení kontejnerů pomocí Pythonu

  • Článek

Tento článek ukazuje, jak vytvořit a spravovat zapůjčení kontejnerů pomocí klientské knihovny Azure Storage pro Python. Klientskou knihovnu můžete použít k získání, obnovení, uvolnění a přerušení zapůjčení kontejnerů.

Informace o pronájmu kontejneru objektů blob pomocí asynchronních rozhraní API najdete v tématu Zapůjčení kontejnerů asynchronně.

Požadavky

  • Tento článek předpokládá, že už máte projekt nastavený tak, aby fungoval s klientskou knihovnou služby Azure Blob Storage pro Python. Další informace o nastavení projektu, včetně instalace balíčku, přidání import příkazů a vytvoření autorizovaného klientského objektu, najdete v tématu Začínáme se službou Azure Blob Storage a Pythonem.
  • Autorizační mechanismus musí mít oprávnění pro práci s zapůjčením kontejneru. Další informace najdete v pokynech k autorizaci pro následující operaci rozhraní REST API:

O zapůjčení kontejnerů

Zapůjčení vytvoří a spravuje zámek kontejneru pro operace odstranění. Doba trvání zámku může být 15 až 60 sekund nebo může být nekonečná. Zapůjčení kontejneru poskytuje výhradní přístup k odstranění kontejneru. Zapůjčení kontejneru řídí pouze možnost odstranění kontejneru pomocí operace Odstranit rozhraní REST API kontejneru . Pokud chcete odstranit kontejner s aktivním zapůjčením, musí klient do žádosti o odstranění zahrnout aktivní ID zapůjčení. Všechny ostatní operace kontejneru jsou úspěšné u zapůjčeného kontejneru bez ID zapůjčení. Pokud jste povolili obnovitelné odstranění kontejneru, můžete odstraněné kontejnery obnovit.

Další informace o stavech zapůjčení a o tom, kdy můžete provést danou akci u zapůjčení, najdete v tématu Stavy zapůjčení a akce.

Operace zapůjčení zpracovává třída BlobLeaseClient , která poskytuje klienta obsahující všechny operace zapůjčení objektů blob a kontejnerů. Další informace o zapůjčení objektů blob pomocí klientské knihovny najdete v tématu Vytváření a správa zapůjčení objektů blob pomocí Pythonu.

Získání zapůjčení

Když získáte zapůjčení kontejneru, získáte ID zapůjčení, které váš kód může použít k provozu s kontejnerem. Pokud už kontejner má aktivní zapůjčení, můžete požádat pouze o nové zapůjčení pomocí id aktivního zapůjčení. Můžete ale zadat novou dobu zapůjčení.

Pokud chcete získat zapůjčení, vytvořte instanci třídy BlobLeaseClient a pak použijte následující metodu:

Zapůjčení můžete získat také pomocí následující metody z třídy ContainerClient :

Následující příklad získá 30sekundové zapůjčení kontejneru:

def acquire_container_lease(self, blob_service_client: BlobServiceClient, container_name):
    # Instantiate a ContainerClient
    container_client = blob_service_client.get_container_client(container=container_name)

    # Acquire a 30-second lease on the container
    lease_client = container_client.acquire_lease(30)

    return lease_client

Prodloužení zapůjčení

Pokud ID zapůjčení zadané v požadavku odpovídá ID zapůjčení přidruženému ke kontejneru, můžete prodloužit zapůjčení kontejneru. Zapůjčení je možné obnovit i v případě, že vypršela jeho platnost, pokud se od vypršení platnosti tohoto zapůjčení znovu nepropůjčí kontejner. Když prodloužíte zapůjčení, doba trvání zapůjčení se resetuje.

Pokud chcete prodloužit zapůjčení, použijte následující metodu:

Následující příklad obnoví zapůjčení kontejneru:

def renew_container_lease(self, lease_client: BlobLeaseClient):
    # Renew a lease on the container
    lease_client.renew()

Uvolnění zapůjčení

Zapůjčení kontejneru můžete uvolnit, pokud ID zapůjčení zadané v požadavku odpovídá ID zapůjčení přidruženému ke kontejneru. Uvolnění zapůjčení umožňuje jinému klientovi získat zapůjčení kontejneru okamžitě po dokončení vydání.

Zapůjčení můžete uvolnit pomocí následující metody:

Následující příklad uvolní zapůjčení kontejneru:

def release_container_lease(self, lease_client: BlobLeaseClient):
    # Release a lease on the container
    lease_client.release()

Přerušení zapůjčení

Pokud má kontejner aktivní zapůjčení, můžete přerušit zapůjčení kontejneru. 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í. Zapůjčení nejde obnovit, jakmile se přeruší, a přerušení zapůjčení zabrání získání nového zapůjčení po určitou dobu, dokud nevyprší platnost původního zapůjčení nebo se uvolní.

Zapůjčení můžete přerušit pomocí následující metody:

Následující příklad přeruší zapůjčení kontejneru:

def break_container_lease(self, lease_client: BlobLeaseClient):
    # Break a lease on the container
    lease_client.break_lease()

Asynchronní zapůjčení kontejnerů

Klientská knihovna Azure Blob Storage pro Python podporuje asynchronně pronájem kontejnerů. Další informace o požadavcích na nastavení projektu najdete v tématu Asynchronní programování.

Při zapůjčení kontejneru pomocí asynchronních rozhraní API postupujte takto:

  1. Přidejte následující příkazy importu:

    import asyncio

from azure.identity.aio import DefaultAzureCredential
from azure.storage.blob.aio import BlobServiceClient, BlobLeaseClient

  2. Přidejte kód pro spuštění programu pomocí asyncio.run. Tato funkce spustí předanou korutinu v main() našem příkladu a spravuje smyčku asyncio událostí. Koroutiny jsou deklarovány syntaxí async/await. V tomto příkladu main() korutin nejprve vytvoří nejvyšší úroveň BlobServiceClient pomocí async with, pak zavolá metodu, která získá zapůjčení kontejneru. Mějte na paměti, že pouze klient nejvyšší úrovně musí používat async with, protože ostatní klienti, kteří z něj vytvořili, sdílejí stejný fond připojení.

    async def main():
    sample = ContainerSamples()

    # TODO: Replace <storage-account-name> with your actual storage account name
    account_url = "https://<storage-account-name>.blob.core.windows.net"
    credential = DefaultAzureCredential()

    async with BlobServiceClient(account_url, credential=credential) as blob_service_client:
        lease_client = await sample.acquire_container_lease(blob_service_client, "sample-container")

if __name__ == '__main__':
    asyncio.run(main())

  3. Přidejte kód pro získání zapůjčení kontejneru. Kód je stejný jako synchronní příklad s tím rozdílem, že metoda je deklarována pomocí async klíčového await slova a klíčové slovo se používá při volání acquire metody.

    async def acquire_container_lease(self, blob_service_client: BlobServiceClient, container_name):
    # Instantiate a ContainerClient
    container_client = blob_service_client.get_container_client(container=container_name)

    # Acquire a 30-second lease on the container
    lease_client = BlobLeaseClient(container_client)
    await lease_client.acquire(lease_duration=30)

    return lease_client

S tímto základním nastavením můžete implementovat další příklady v tomto článku jako koruty pomocí syntaxe async/await.

Stavy a akce zapůjčení

Následující diagram znázorňuje pět stavů zapůjčení a příkazy nebo události, které způsobují změny stavu zapůjčení.

A diagram showing container lease states and state change triggers.

Následující tabulka uvádí pět stavů zapůjčení, uvádí stručný popis jednotlivých stavů a uvádí akce zapůjčení povolené v daném stavu. Tyto akce zapůjčení způsobují přechody stavu, jak je znázorněno v diagramu.

Stav zapůjčení Popis Povolené akce zapůjčení
Dostupný Zapůjčení je odemknuté a dá se získat. acquire
Pronajatých Zapůjčení je uzamčeno. acquire (pouze stejné ID zapůjčení), renew, change, releasea break
Platnost vypršela Doba trvání zapůjčení vypršela. acquire, renew, releasea break
Lámání Zapůjčení bylo přerušeno, ale zapůjčení bude nadále uzamčeno, dokud nevypršela doba přerušení. release a break
Zlomené Zapůjčení bylo přerušeno a doba přerušení vypršela. acquire, releasea break

Po vypršení zapůjčení bude ID zapůjčení udržováno službou Blob Service, dokud se kontejner znovu nezmění nebo zapůjčí. Klient se může pokusit obnovit nebo uvolnit zapůjčení pomocí ID zapůjčení, jehož platnost vypršela. Pokud požadavek selže, klient ví, že byl kontejner znovu zapůjčen, nebo se kontejner odstranil od poslední aktivní zapůjčení.

Pokud vyprší platnost zapůjčení místo explicitního uvolnění, klient může muset počkat až jednu minutu, než bude možné pro kontejner získat nové zapůjčení. Klient však může zapůjčení obnovit okamžitě s ID zapůjčení, jehož platnost vypršela.

Zdroje informací

Další informace o pronájmu kontejneru pomocí klientské knihovny Azure Blob Storage pro Python najdete v následujících zdrojích informací.

Operace rozhraní REST API

Sada Azure SDK pro Python obsahuje knihovny, které jsou postavené na rozhraní Azure REST API a umožňují interakci s operacemi rozhraní REST API prostřednictvím známých paradigmat Pythonu. Metody klientské knihovny pro pronájem kontejneru používají následující operaci rozhraní REST API:

Ukázky kódu

Prostředky klientské knihovny

Viz také