開始使用 Azure Blob 儲存體和 .NET

文章
10/03/2024

本文說明如何使用適用於 .NET 的 Azure Blob 儲存體用戶端程式庫來連線至 Azure Blob 儲存體。連線之後，您的程式碼就可以在 Blob 儲存體服務的容器、Blob 和功能上運作。

API 參考 | 程式庫原始程式碼 | 套件 (NuGet) | 範例 | 提供意見反應

必要條件

Azure 訂用帳戶 - 建立免費帳戶
Azure 儲存體帳戶 - 建立儲存體帳戶
適用於您作業系統的最新 .NET SDK。請務必取得 SDK，而不是執行階段。

設定您的專案

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

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

dotnet add package Azure.Storage.Blobs
dotnet add package Azure.Identity

將這些 using 指示詞新增至程式碼檔案頂端：

using Azure.Identity;
using Azure.Storage.Blobs;
using Azure.Storage.Blobs.Models;
using Azure.Storage.Blobs.Specialized;

Blob 用戶端程式庫資訊:

Azure.Storage.Blobs：包含可用來操作服務、容器和 Blob 的主要類別 (「用戶端物件」)。
Azure.Storage.Blobs.Specialized：包含可用來執行 Blob 類型特定作業的類別，例如區塊 Blob。
Azure.Storage.Blobs.Models：所有其他公用程式類別、結構和列舉類型。

授權存取權並連線到 Blob 儲存體

若要將應用程式連線至 Blob 儲存體，請建立 BlobServiceClient 類別的執行個體。此物件是您與儲存體帳戶層級的資料資源互動的起點。您可以使用它來操作儲存體帳戶及其容器。您也可以使用服務用戶端來建立容器用戶端或 Blob 用戶端，視您需要使用的資源而定。

若要深入了解如何建立及管理用戶端物件，請參閱建立和管理與資料資源互動的用戶端端物件 (部分機器翻譯)。

您可以使用 Microsoft Entra 授權權杖、帳戶存取密鑰或共用存取簽章 (SAS) 來授權 BlobServiceClient 物件。為了實現最佳安全性，Microsoft 建議使用具有受控識別的 Microsoft Entra ID 來授權針對 Blob 資料的要求。如需更多資訊，請參閱使用 Microsoft Entra ID 授與 Blob 的存取權。

若要使用 Microsoft Entra ID 進行授權，您必須使用安全性主體。您需要的安全性主體類型取決於您的應用程式執行位置。請使用下表作為指南。

應用程式的執行位置	安全性主體	指引
本機電腦 (開發和測試)	服務主體	若要了解如何註冊應用程式、設定 Microsoft Entra 群組、指派角色及設定環境變數，請參閱使用開發人員服務主體授權存取
本機電腦 (開發和測試)	使用者身分識別	若要了解如何設定 Microsoft Entra 群組、指派角色並登入 Azure，請參閱使用開發人員認證授權存取
裝載於 Azure 中	受控識別	若要了解如何啟用受控識別並指派角色，請參閱使用受控識別從 Azure 裝載的應用程式授權存取
裝載在 Azure 外部 (例如內部部署應用程式)	服務主體	若要了解如何註冊應用程式、指派角色及設定環境變數，請參閱使用應用程式服務主體從内部部署應用程式授權存取

使用 DefaultAzureCredential 授權存取

授權存取權並連線到 Blob 儲存體簡單又安全的方式，是藉由建立 DefaultAzureCredential 執行個體來取得 OAuth 權杖。然後，您可以使用該認證來建立 BlobServiceClient 物件。

下列範例會建立使用 DefaultAzureCredential 授權的 BlobServiceClient 物件：

public BlobServiceClient GetBlobServiceClient(string accountName)
{
    BlobServiceClient client = new(
        new Uri($"https://{accountName}.blob.core.windows.net"),
        new DefaultAzureCredential());

    return client;
}

如果您確切知道要用來驗證使用者的認證類型，您可使用適用於 .NET 的 Azure 身分識別用戶端程式庫中的其他類別來取得 OAuth 權杖。這些類別衍生自 TokenCredential 類別。

使用 Blob 服務端點和 SAS 權杖來建立 Uri。然後，使用 Uri 建立 BlobServiceClient。

public static void GetBlobServiceClientSAS(ref BlobServiceClient blobServiceClient,
    string accountName, string sasToken)
{
    string blobUri = "https://" + accountName + ".blob.core.windows.net";

    blobServiceClient = new BlobServiceClient
    (new Uri($"{blobUri}?{sasToken}"), null);
}

若要深入了解如何產生和管理 SAS 權杖，請參閱下列文章:

注意

針對使用共用存取簽章 (SAS) 的案例，Microsoft 建議使用使用者委派 SAS。使用者委派 SAS 會使用 Microsoft Entra 認證來保護，而不是使用帳戶金鑰。

使用儲存體帳戶名稱和帳戶金鑰來建立 StorageSharedKeyCredential。然後，使用該物件來初始化 BlobServiceClient。

public static void GetBlobServiceClient(ref BlobServiceClient blobServiceClient,
    string accountName, string accountKey)
{
    Azure.Storage.StorageSharedKeyCredential sharedKeyCredential =
        new StorageSharedKeyCredential(accountName, accountKey);

    string blobUri = "https://" + accountName + ".blob.core.windows.net";

    blobServiceClient = new BlobServiceClient
        (new Uri(blobUri), sharedKeyCredential);
}

您也可以使用連接字串來建立 BlobServiceClient。

BlobServiceClient blobServiceClient = new BlobServiceClient(connectionString);

關於如何取得帳戶金鑰及正確管理和保護金鑰的最佳做法指導方針，如需相關資訊，請參閱管理儲存體帳戶存取金鑰。

重要

應該謹慎使用帳戶存取金鑰。如果帳戶存取金鑰遺失或意外放在不安全的地方，您的服務可能變得易受攻擊。任何擁有存取金鑰的人都可以授權執行目標為儲存體帳戶的要求，而且可實質存取所有資料。 DefaultAzureCredential 會提供增強的安全性功能和優點，建議用來管理對 Azure 服務的授權。

若要深入了解上述各種授權機制，請參閱授權存取 Azure 儲存體中的資料。

建置應用程式

當您建置應用程式以在 Azure Blob 儲存體中使用資料資源時，您的程式碼主要會與三種資源類型互動：儲存體帳戶、容器和 Blob。若要深入了解這些資源類型、彼此的關係，以及應用程式如何與資源互動，請參閱了解應用程式如何與 Blob 儲存體資料資源互動。

下列指南說明如何使用適用於 .NET 的 Azure 儲存體用戶端連結庫來存取數據及執行特定動作：

指南	描述
將資料附加至 Blob	了解如何建立附加 Blob，然後將資料附加至該 Blob。
設定重試原則 (部分機器翻譯)	實作用戶端作業的重試原則。
複製 Blob	將 Blob 從一個位置複製到另一個位置。
建立容器	建立容器。
建立使用者委派 SAS	建立容器或 Blob 的使用者委派 SAS。
建立和管理 blob 租用	建立和管理 Blob 上的鎖定。
建立和管理容器租用	在容器上建立和管理鎖定。
刪除和還原 Blob	刪除 Blob 和 (如果已啟用虛刪除) 還原已刪除的 Blob。
刪除和還原容器	刪除容器和 (如果已啟用虛刪除) 還原已刪除的容器。
下載 Blob	使用字串、串流和檔案路徑來下載 Blob。
使用標籤來尋找 Blob	設定和擷取標籤，以及使用標籤來尋找 Blob。
列出 Blob	以各種方式列出 Blob。
列出容器	列出帳戶中的容器，以及可用來自訂清單的各種選項。
管理屬性和中繼資料	取得和設定 Blob 的屬性和中繼資料。
管理屬性和中繼資料	取得和設定容器的屬性和中繼資料。
資料傳輸的效能微調	最佳化資料傳輸作業的效能。
設定或變更 Blob 的存取層	設定及變更區塊 Blob 的存取層。
上傳 Blob	了解如何使用字串、串流、檔案路徑和其他方法來上傳 Blob。

分享方式：