使用 Python 建立和管理 Blob 租用
本文會說明如何使用 適用於 Python 的 Azure 儲存體用戶端程式庫 來建立和管理 Blob 租用。 您可以使用用戶端程式庫來取得、更新、發行及中斷 Blob 租用。
若要了解如何使用非同步 API 租用 Blob，請參閱以非同步方式租用 Blob。
必要條件
- Azure 訂用帳戶 - 建立免費帳戶
- Azure 儲存體帳戶 - 建立儲存體帳戶
- Python 3.8+
設定您的環境
如果沒有現有的專案，本章節會說明如何設定專案以使用適用於 Python 的 Azure Blob 儲存體用戶端程式庫。 如需詳細資訊，請參閱開始使用 Azure Blob 儲存體和 Python。
若要使用本文中的程式碼範例，請遵循下列步驟來設定您的專案。
安裝套件
使用 pip install 安裝下列套件：
pip install azure-storage-blob azure-identity
新增 import 陳述式
加入下列 import 陳述式：
from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient, BlobLeaseClient
授權
授權機制必須具有使用 Blob 租用所需的權限。 如需使用 Microsoft Entra ID 授權 (建議使用)，您需要 Azure RBAC 內建角色儲存體 Blob 資料參與者或更高權限。 若要深入了解，請參閱租用 Blob (REST API) (部分機器翻譯) 的授權指導。
建立用戶端物件
若要將應用程式連線至 Blob 儲存體，請建立 BlobServiceClient類別的執行個體。 下列範例示範如何使用 DefaultAzureCredential 來建立用戶端物件以進行授權：
# TODO: Replace <storage-account-name> with your actual storage account name
account_url = "https://<storage-account-name>.blob.core.windows.net"
credential = DefaultAzureCredential()
# Create the BlobServiceClient object
blob_service_client = BlobServiceClient(account_url, credential=credential)
您也可以直接或從 BlobServiceClient 物件建立特定容器或 Blob 的用戶端物件。 若要深入了解如何建立及管理用戶端物件，請參閱建立和管理與資料資源互動的用戶端端物件 (部分機器翻譯)。
關於 Blob 租用
租用會在 Blob 上建立及管理鎖定，藉以寫入和刪除作業。 鎖定持續時間的範圍是 15 到 60 秒，也可以設為無限。 Blob 上的租用會提供寫入及刪除 Blob 的專有存取權。 若要寫入含有作用中租用的 Blob，用戶端必須包含具有寫入要求的作用中租用識別碼。
若要深入了解租用狀態，以及何時可以在租用上執行指定動作，請參閱租用狀態和動作。
將具有作用中租用的 Blob 包含在內的容器上會允許所有的容器作業，包括刪除容器。 因此，即使容器中的 Blob 具有作用中的租用，還是可能會刪除容器。 使用租用容器作業以控制刪除容器的權限。
租用作業是由 BlobLeaseClient 類別處理，其提供一個用戶端，包含 Blob 和容器的所有租用作業。 若要深入了解使用用戶端程式庫的容器租用，請參閱 使用 Python 建立和管理容器租用。
取得租用
當您取得 Blob 租用時，會取得一個租用識別碼，讓您的程式碼可用來在 Blob 上運作。 如果 Blob 已經有作用中的租用，您只能使用作用中的租用識別碼來要求新的租用。 不過，您可以指定新的租用期間。
若要取得租用，請建立 BlobLeaseClient 類別的執行個體，然後使用下列方法：
您也可以建立 BlobClient 執行個體，並使用下列方法來取得 Blob 上的租用：
下列範例會取得 Blob 的 30 秒租用：
def acquire_blob_lease(self, blob_service_client: BlobServiceClient, container_name):
# Instantiate a BlobClient
blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt")
# Acquire a 30-second lease on the blob
lease_client = blob_client.acquire_lease(30)
return lease_client
更新租用
如果在要求上指定的租用識別碼符合該 Blob 相關聯的租用識別碼，則可以更新 Blob 租用。 租用到期之後，只要 Blob 未曾修改或再度租用，即使租用已到期，還是可以更新。 當您更新租用時，租用期間會重設。
若要更新租用，請使用下列方法：
下列範例會更新 Blob 的租用：
def renew_blob_lease(self, lease_client: BlobLeaseClient):
# Renew a lease on a blob
lease_client.renew()
釋放租用
如果在要求上指定的租用識別碼符合該 Blob 相關聯的租用識別碼，則可以釋放 Blob 租用。 發行租用可讓其他用戶端在發行完成時，立即取得 Blob 的租用。
您可以使用下列方法來釋放租用：
下列範例會發行 Blob 上的租用:
def release_blob_lease(self, lease_client: BlobLeaseClient):
# Release a lease on a blob
lease_client.release()
中斷租用
如果 Blob 有作用中的租用，您可以中斷租用。 任何獲授權的要求都可以中斷租用；無需要求即可指定相符的租用識別碼。 租用在中斷之後會無法更新，而且中斷租用之後的一段期間内將無法取得新租用，直到原始租用到期或釋放爲止。
您可以使用下列方法來中斷租用：
下列範例會中斷 Blob 上的租用:
def break_blob_lease(self, lease_client: BlobLeaseClient):
# Break a lease on a blob
lease_client.break_lease()
以非同步方式租用 Blob
適用於 Python 的 Azure Blob 儲存體用戶端程式庫支援以非同步方式租用 Blob。 若要深入了解專案設定需求，請參閱非同步程式設計。
依照下列步驟，使用非同步 API 租用 Blob：
新增下列匯入陳述式：
import asyncio from azure.identity.aio import DefaultAzureCredential from azure.storage.blob.aio import BlobServiceClient, BlobLeaseClient新增程式碼以使用
asyncio.run執行程式。 此函式會執行傳遞的協同程式 (在我們的範例中為main())，並管理asyncio事件迴圈。 協同程式會以 async/await 語法宣告。 在此範例中，main()協同程式會先使用async with建立最上層BlobServiceClient，然後呼叫取得 Blob 租用的方法。 請注意，只有最上層用戶端需要使用async with，因為從中建立的其他用戶端會共用相同的連線集區。async def main(): sample = BlobSamples() # 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_blob_lease(blob_service_client, "sample-container") if __name__ == '__main__': asyncio.run(main())新增程式碼以取得 Blob 租用。 該程式碼與同步範例相同，不同之處在於該方法是以
async關鍵字宣告的，而await關鍵字是在呼叫acquire_lease方法時使用的。async def acquire_blob_lease(self, blob_service_client: BlobServiceClient, container_name): # Instantiate a BlobClient blob_client = blob_service_client.get_blob_client(container=container_name, blob="sample-blob.txt") # Acquire a 30-second lease on the blob lease_client = await blob_client.acquire_lease(30) return lease_client
完成這個基本設定後，您可以使用 async/await 語法將本文中的其他範例實作為協同程式。
租用狀態和動作
下圖會顯示租用的五個狀態，以及會導致租用狀態變更的命令或事件。
下表會列出五個租用狀態、提供每個租用狀態的簡短描述，並列出指定狀態中允許的租用動作。 這些租用動作會導致狀態轉換，如下圖所示。
| 租用狀態 | 描述 | 允許的租用動作 |
|---|---|---|
| 可用的 | 租用已解除鎖定，並且可以取得。 | acquire |
| 已租用 | 租用已鎖定。 | acquire (僅限相同的租用識別碼)、renew、change、release 和 break |
| 已到期 | 租用期間到期。 | acquire、renew、release 和 break |
| 正在中斷 | 租用已中斷，但租用將繼續鎖定，直到中斷期間到期為止。 | release 和 break |
| 中斷 | 租用已中斷，且中斷期間已到期。 | acquire、release 和 break |
租用到期時，租用識別碼會由 Blob 服務維護，直到 Blob 修改或再度租用。 用戶端可能會嘗試使用過期的租用識別碼來更新或釋放租用。 如果此作業成功，用戶端就會知道自從租用識別碼上次有效以來，Blob 都未變更。 如果要求失敗，用戶端就會知道 Blob 已被修改，或自從租用上次作用之後，Blob 已再次租用。 接著，用戶端就必須在 Blob 上取得新的租用。
如果租用到期，而不是明確地釋放，用戶端可能需要稍候一分鐘，才能為 Blob 取得新的租用。 不過，如果 Blob 未被修改，用戶端就可以立即以其租用識別碼來更新租用。
因為快照集是唯讀狀態，所以無法為 Blob 快照集授與租用。 針對快照集要求租用會產生狀態碼 400 (Bad Request)。
資源
若要深入了解如何使用適用於 Python 的 Azure Blob 儲存體用戶端程式庫管理 Blob 租用，請參閱下列資源。
程式碼範例
REST API 操作
適用於 Python 的 Azure SDK 包含建置在 Azure REST API 之上的程式庫，可讓您透過熟悉的 Python 範例與 REST API 作業進行互動。 用來管理 Blob 租用的用戶端程式庫方法會使用下列 REST API 作業：
用戶端程式庫資源
另請參閱
相關內容
- 本文是適用於 Python 的 Blob 儲存體開發人員指南的一部分。 若要深入了解，請參閱 建置 Python 應用程式 中的開發人員指南文章完整清單。