共用方式為

快速入門：適用於 Python 的 Azure Blob 儲存體用戶端程式庫

  • 發行項

注意

[從頭開始建置] 選項會逐步引導您逐步完成建立新專案、安裝套件、撰寫程式碼，以及執行基本主控台應用程式的流程。 如果您想要了解建立應用程式以連線至 Azure Blob 儲存體所涉及的所有詳細資料，建議您使用此方法。 如果您偏好將部署工作自動化，並從已完成的專案開始，請選擇從範本開始。

注意

[從範本開始] 選項會使用 Azure Developer CLI 將部署工作自動化，並使您從已完成的專案開始。 如果您想要儘快探索程式碼，而不完成設定工作，建議您使用此方法。 如果您偏好使用逐步指示來建置應用程式，請選擇從頭開始建置。

開始使用適用於 Python 的 Azure Blob 儲存體用戶端程式庫管理 Blob 和容器。

在本文中，您會遵循步驟來安裝套件，並嘗試基本工作的範例程式碼。

在本文中，您會使用 Azure Developer CLI 來部署 Azure 資源，並只用幾個命令來執行已完成的主控台應用程式。

API 參考文件 | 程式庫來源程式碼 | 套件 (PyPi) | 範例

這部影片說明如何開始使用適用於 Python 的 Azure Blob 儲存體用戶端程式庫。

下列各節也會描述影片中的步驟。

必要條件

設定

本節會引導您準備專案以搭配適用於 Python 的 Azure Blob 儲存體用戶端程式庫使用。

建立專案

建立一個名為 blob-quickstart 的 Python 應用程式。

  1. 在主控台視窗 (例如 PowerShell 或 Bash) 中，為專案建立一個新目錄：

    mkdir blob-quickstart

  2. 切換至新建立的 blob-quickstart 目錄：

    cd blob-quickstart

安裝套件

從專案目錄中，使用 pip install 命令安裝 Azure Blob 儲存體和 Azure 身分識別用戶端程式庫的套件。 需要 Azure 身分識別 套件才能對 Azure 服務進行無密碼連線。

pip install azure-storage-blob azure-identity

設定應用程式架構

從專案目錄，遵循步驟來建立應用程式的基本結構：

  1. 在程式碼編輯器中開啟新的文字檔。
  2. 新增 import 陳述式、建立程式的結構，以及包含基本例外狀況處理，如下所示。
  3. 將新檔案以 blob_quickstart.py 儲存在 blob-quickstart 目錄中。
import os, uuid
from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient, BlobClient, ContainerClient

try:
    print("Azure Blob Storage Python quickstart sample")

    # Quickstart code goes here

except Exception as ex:
    print('Exception:')
    print(ex)

安裝 Azure Developer CLI 後，您可以建立儲存體帳戶，並只用幾個命令來執行範例程式碼。 您可以在本機開發環境中或在 DevContainer 中執行專案。

初始化 Azure Developer CLI 範本並部署資源

從空目錄，遵循下列步驟來初始化 azd 範本、佈建 Azure 資源，以及開始使用程式碼：

  • 從 GitHub 複製快速入門存放庫資產，並在本機初始化範本：

    azd init --template blob-storage-quickstart-python

    系統將會提示您輸入下列資訊：

    • 環境名稱：對於 Azure Developer CLI 建立的所有 Azure 資源，此值會用作其前置詞。 名稱在所有 Azure 訂用帳戶中必須是唯一的，且長度必須介於 3 與 24 個字元之間。 名稱僅能包含數字和小寫字母。

  • 登入 Azure：

    azd auth login

  • 佈建資源並將其部署至 Azure：

    azd up

    系統將會提示您輸入下列資訊：

    • 訂用帳戶：您資源部署至的 Azure 訂用帳戶。
    • 位置：部署資源的區域。

    部署可能需要幾分鐘的時間才能完成。 azd up 命令的輸出包含新建立的儲存體帳戶名稱，稍後您將需要此儲存體帳戶來執行程式碼。

執行範例程式碼

此時，資源會部署至 Azure，且程式碼幾乎已準備好執行。 請遵循下列步驟來安裝套件、更新程式碼中的儲存體帳戶名稱，並執行範例主控台應用程式：

  • 安裝套件：在本機目錄中，使用下列命令安裝 Azure Blob 儲存體和 Azure 身分識別用戶端程式庫的套件：pip install azure-storage-blob azure-identity
  • 更新儲存體帳戶名稱：在本機目錄中，編輯名為 blob_quickstart.py 的檔案。 尋找 <storage-account-name> 預留位置，並將其取代為 azd up 命令所建立的儲存體帳戶實際名稱。 儲存變更。
  • 執行專案：執行下列命令來執行應用程式：python blob_quickstart.py。
  • 觀察輸出：此應用程式會在本機 data 資料夾中建立一個測試檔案，並將其上傳到儲存體帳戶中的容器。 範例會接著列出容器中的 Blob，並下載具有新名稱的檔案，您便可比較舊檔案和新檔案。

若要深入了解範例程式碼的運作方式，請參閱程式碼範例。

當您完成了測試程式碼時，請參閱清除資源一節，以刪除 azd up 命令所建立的資源。

物件模型

Azure Blob 儲存體已針對儲存大量非結構化資料進行最佳化。 「非結構化資料」是指不符合特定資料模型或定義的資料，例如文字或二進位資料。 Blob 儲存體提供三種類型資源：

  • 儲存體帳戶
  • 儲存體帳戶中的容器
  • 容器中的 Blob

下圖顯示這些資源之間的關係：

Blob 儲存體架構圖

使用下列 Python 類別與這些資源互動：

  • BlobServiceClient：BlobServiceClient 類別可讓您操作 Azure 儲存體資源和 Blob 容器。
  • ContainerClient：ContainerClient 類別可讓您操作 Azure 儲存體容器及其 Blob。
  • BlobClient：BlobClient 類別可讓您操作 Azure 儲存體 Blob。

程式碼範例

這些範例程式碼片段會示範如何使用適用於 Python 的 Azure Blob 儲存體用戶端程式庫執行下列工作：

注意

Azure Developer CLI 範本包含範例程式碼已就緒的檔案。 下列範例為範例程式碼的每個部分提供詳細資料。 此範本會實作建議的無密碼驗證方法，如向 Azure 驗證一節中所述。 連接字串方法會顯示為替代方案，但不會用於範本中，且不建議用於實際執行程式碼。

向 Azure 驗證，並授權存取 Blob 資料

應用程式向 Azure Blob 儲存體提出的要求必須經過授權。 在程式碼中實作對 Azure 服務 (包括 Blob 儲存體) 的無密碼連線時，建議使用 Azure.Identity 用戶端程式庫提供的 DefaultAzureCredential 類別。

您也可以使用帳戶存取金鑰，以授權對 Azure Blob 儲存體的要求。 不過，應該謹慎使用此方法。 開發人員必須盡可能避免在不安全的地方公開存取金鑰。 任何擁有存取金鑰的人都可以授權執行目標為儲存體帳戶的要求，而且可實質存取所有資料。 DefaultAzureCredential 提供優於帳戶金鑰的管理和安全性優點，允許無密碼驗證。 下列範例示範這兩個選項。

DefaultAzureCredential 支援多個驗證方法，並在執行階段判斷應該使用哪個方法。 此方法可讓您的應用程式在不同的環境中 (本機或實際執行環境) 使用不同的驗證方法，而不需要實作環境特有的程式碼。

在 Azure 身分識別程式庫概觀中可以找到 DefaultAzureCredential 尋找認證時的順序和位置。

例如，應用程式在本機開發時可以使用 Azure CLI 登入認證進行驗證。 應用程式在部署至 Azure 之後就可以使用受控識別。 此轉移不需要變更程式碼。

將角色指派給 Microsoft Entra 使用者帳戶

在本機開發時，請確定存取 Blob 資料的使用者帳戶具有正確的權限。 您需要儲存體 Blob 資料參與者才能讀取和寫入 Blob 資料。 若要指派此角色給您自己，您需要被指派使用者存取管理員角色，或另一個包含 Microsoft.Authorization/roleAssignments/write 動作的角色。 您可以使用 Azure 入口網站、Azure CLI 或 Azure PowerShell，將 Azure RBAC 角色指派給使用者。 您可以在範圍概觀頁面上深入了解角色指派的可用範圍。

在此案例中，您會將權限指派給使用者帳戶 (以儲存體帳戶為範圍)，以遵循最低權限原則。 此做法只為使用者提供所需的最低權限，並建立更安全的實際執行環境。

下列範例將儲存體 Blob 資料參與者角色指派給使用者帳戶，以針對儲存體帳戶中的 Blob 資料提供讀取和寫入存取權。

重要

在大部分情況下，角色指派在 Azure 中傳播只需要一兩分鐘，但在罕見情況下，可能需要長達八分鐘。 如果您第一次執行程式碼時收到驗證錯誤，請稍候片刻再試一次。

  1. 在 Azure 入口網站中，使用主要搜尋列或左側導覽找出您的儲存體帳戶。

  2. 在儲存體帳戶概觀頁面上，從左側功能表中選取 [存取控制 (IAM)]。

  3. 在 [存取控制 (IAM)] 頁面上，選取 [角色指派] 索引標籤。

  4. 從頂端功能表選取 [+ 新增]，然後從產生的下拉功能表中選取 [新增角色指派]。

    顯示如何指派角色的螢幕擷取畫面。

  5. 使用搜尋方塊，從結果篩選出所需的角色。 在此範例中，搜尋「儲存體 Blob 資料參與者」，選取相符的結果，然後選擇 [下一步]。

  6. 在 [存取權指派對象為] 下，選取 [使用者、群組或服務主體]，然後選擇 [+ 選取成員]。

  7. 在對話方塊中，搜尋 Microsoft Entra 使用者名稱 (通常是您的 user@domain 電子郵件地址)，然後在對話方塊底部選擇 [選取]。

  8. 選取 [檢閱 + 指派] 以移至最終頁面，然後再次選取 [檢閱 + 指派] 以完成此程序。

使用 DefaultAzureCredential 登入並將應用程式程式碼連線至 Azure

您可以使用下列步驟來授權存取儲存體帳戶中的資料：

  1. 請確定使用您在儲存體帳戶上指派角色的相同 Microsoft Entra 帳戶進行驗證。 您可以透過 Azure CLI、Visual Studio Code 或 Azure PowerShell 進行驗證。

    使用下列命令透過 Azure CLI 登入 Azure：

    az login

  2. 若要使用 DefaultAzureCredential，請確定已安裝 azure-identity 套件，並匯入了下列類別：

    from azure.identity import DefaultAzureCredential
from azure.storage.blob import BlobServiceClient

  3. 在 try 區塊內新增此程式碼。 程式碼在本機工作站上執行時，DefaultAzureCredential 會根據您優先用來登入的工具，使用其開發人員認證以向 Azure 驗證。 這些工具的範例包括 Azure CLI 或 Visual Studio Code。

    account_url = "https://<storageaccountname>.blob.core.windows.net"
default_credential = DefaultAzureCredential()

# Create the BlobServiceClient object
blob_service_client = BlobServiceClient(account_url, credential=default_credential)

  4. 請務必在 BlobServiceClient 物件的 URI 中更新儲存體帳戶名稱。 您可以在 Azure 入口網站的概觀頁面上找到儲存體帳戶名稱。

    顯示如何尋找儲存體帳戶名稱的螢幕擷取畫面。

    注意

    部署至 Azure 時，您可以使用上述程式碼，從 Azure 中執行的應用程式授權對 Azure 儲存體的要求。 不過，在 Azure 中，您必須在應用程式中啟用受控識別。 然後，將您的儲存體帳戶設定為允許該受控識別進行連線。 如需在 Azure 服務之間設定此連線的詳細指示，請參閱從 Azure 託管應用程式進行驗證教學課程。

建立容器

在 blob_service_client 物件上呼叫 create_container 方法，以在您的儲存體帳戶中建立新容器。 在此範例中，程式碼會將 GUID 值附加到容器名稱，以確保其為唯一名稱。

將此程式碼加入到 try 區塊的結尾處：

# Create a unique name for the container
container_name = str(uuid.uuid4())

# Create the container
container_client = blob_service_client.create_container(container_name)

若要深入了解建立容器的相關資訊，以及探索更多程式碼範例，請參閱使用 Python 建立 Blob 容器。

重要

容器名稱必須是小寫字母。 如需為容器和 Blob 命名的詳細資訊，請參閱命名和參考容器、Blob 及中繼資料。

將 Blob 上傳至容器

使用 upload_blob 將 Blob 上傳至容器。 此範例程式碼會在本機 data 目錄中建立文字檔，以上傳至容器。

將此程式碼加入到 try 區塊的結尾處：

# Create a local directory to hold blob data
local_path = "./data"
os.mkdir(local_path)

# Create a file in the local data directory to upload and download
local_file_name = str(uuid.uuid4()) + ".txt"
upload_file_path = os.path.join(local_path, local_file_name)

# Write text to the file
file = open(file=upload_file_path, mode='w')
file.write("Hello, World!")
file.close()

# Create a blob client using the local file name as the name for the blob
blob_client = blob_service_client.get_blob_client(container=container_name, blob=local_file_name)

print("\nUploading to Azure Storage as blob:\n\t" + local_file_name)

# Upload the created file
with open(file=upload_file_path, mode="rb") as data:
    blob_client.upload_blob(data)

若要深入了解如何上傳 Blob，以及探索更多程式碼範例，請參閱使用 Python 上傳 Blob。

列出容器中的 Blob

呼叫 list_blobs 方法，以列出容器中的 Blob。 在此情況下，只有一個 Blob 已新增至容器，因此清單作業只會傳回該 Blob。

將此程式碼加入到 try 區塊的結尾處：

print("\nListing blobs...")

# List the blobs in the container
blob_list = container_client.list_blobs()
for blob in blob_list:
    print("\t" + blob.name)

若要深入了解如何列出 Blob，以及探索更多程式碼範例，請參閱使用 Python 列出 Blob。

下載 Blob

呼叫 download_blob 方法，以下載先前建立的 Blob。 此範例程式碼會將 "DOWNLOAD" 的尾碼加入至檔案名稱，讓您可以在本機檔案系統中看到這兩個檔案。

將此程式碼加入到 try 區塊的結尾處：

# Download the blob to a local file
# Add 'DOWNLOAD' before the .txt extension so you can see both files in the data directory
download_file_path = os.path.join(local_path, str.replace(local_file_name ,'.txt', 'DOWNLOAD.txt'))
container_client = blob_service_client.get_container_client(container= container_name) 
print("\nDownloading blob to \n\t" + download_file_path)

with open(file=download_file_path, mode="wb") as download_file:
 download_file.write(container_client.download_blob(blob.name).readall())

若要深入了解如何下載 Blob，以及探索更多程式碼範例，請參閱使用 Python 下載 Blob。

刪除容器

下列程式碼會使用 delete_container 方法移除整個容器，以清除應用程式所建立的資源。 您也可以視需要刪除本機檔案。

應用程式會在刪除 Blob、容器和本機檔案之前呼叫 input()，藉以暫停使用者輸入。 確認已正確建立資源，然後才將其刪除。

將此程式碼加入到 try 區塊的結尾處：

# Clean up
print("\nPress the Enter key to begin clean up")
input()

print("Deleting blob container...")
container_client.delete_container()

print("Deleting the local source and downloaded files...")
os.remove(upload_file_path)
os.remove(download_file_path)
os.rmdir(local_path)

print("Done")

若要深入了解如何刪除容器，以及探索更多程式碼範例，請參閱使用 Python 刪除及還原 Blob 容器。

執行程式碼

此應用程式會在本機資料夾中建立一個測試檔案，並將其上傳到 Azure Blob 儲存體。 然後，此範例會列出容器中的 Blob，並下載具有新名稱的檔案。 您可以比較舊檔案和新檔案。

瀏覽至包含 blob_quickstart.py 檔案的目錄，然後執行下列 python 命令來執行應用程式：

python blob_quickstart.py

應用程式的輸出類似於下列範例 (為了可讀性省略了 UUID 值)：

Azure Blob Storage Python quickstart sample

Uploading to Azure Storage as blob:
        quickstartUUID.txt

Listing blobs...
        quickstartUUID.txt

Downloading blob to
        ./data/quickstartUUIDDOWNLOAD.txt

Press the Enter key to begin clean up

Deleting blob container...
Deleting the local source and downloaded files...
Done

在開始清除程序之前，請檢查 data 資料夾，找出這兩個檔案。 您可以比較這些檔案，並觀察它們是否相同。

清除資源

驗證檔案並完成測試之後，請按 Enter 鍵，刪除測試檔案，以及在儲存體帳戶中建立的容器。 您也可以使用 Azure CLI 來刪除資源。

完成快速入門時，您可以執行下列命令來清除您所建立的資源：

azd down

系統將會提示您確認刪除資源。 輸入 y 以確認。

後續步驟

適用於 Python 的 Azure 儲存體範例和開發人員指南