適用于 .NET 的 Azure WebJobs 儲存體 Blob 用戶端程式庫 - 5.1.1 版

發行項
04/03/2023

此延伸模組提供在 Azure Functions 中存取 Azure 儲存體 Blob 的功能。

開始使用

安裝套件

使用 NuGet安裝儲存體 Blob 擴充功能：

dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage.Blobs

必要條件

您需要 Azure 訂用帳戶和儲存體帳戶才能使用此套件。

若要建立新的儲存體帳戶，您可以使用Azure入口網站、Azure PowerShell或Azure CLI。以下是使用 Azure CLI 的範例：

az storage account create --name <your-resource-name> --resource-group <your-resource-group-name> --location westus --sku Standard_LRS

驗證用戶端

若要讓擴充功能存取 Blob，您需要可在 Azure 入口網站中找到的連接字串，或使用下面的 Azure CLI 程式碼片段。

az storage account show-connection-string -g <your-resource-group-name> -n <your-resource-name>

連接字串可透過 AzureWebJobsStorage 應用程式設定來提供。

重要概念

使用 Blob 觸發程式

偵測到新的或已更新的 Blob 時，Blob 儲存體觸發程序會啟動函式。 Blob 內容會當成函式輸入提供。

請遵循教學課程，以瞭解在修改 Blob 時觸發 Azure 函式。

接聽策略

Blob 觸發程式在接聽 Blob 建立和修改時提供少數策略。您可以藉由指定 Source (的屬性 BlobTrigger 來自訂策略，請參閱下列範例) 。

預設策略

根據預設，Blob 觸發程式會使用輪詢，在檢查 Azure 儲存體分析記錄和執行定期容器掃描之間作為混合式。 Blob 一次掃會描 10000 個群組，並在間隔之間使用接續權杖。

Azure 儲存體分析記錄預設不會啟用，請參閱 Azure 儲存體分析記錄，以瞭解如何啟用。

不建議針對需要低延遲的高延展性應用程式或案例使用此策略。

事件方格

Blob 儲存體事件可用來接聽變更。此策略需要額外的設定。

此策略建議用於大規模應用程式。

使用 Blob 系結

輸入繫結可讓您將 Blob 儲存體資料當做 Azure 函式的輸入來讀取。輸出繫結可讓您修改及刪除 Azure Function 中的 Blob 儲存體資料。

請遵循輸入系結教學課程和輸出系結教學課程，瞭解如何使用此擴充功能來存取 Blob。

範例

回應 Blob 變更

預設策略

public static class BlobFunction_ReactToBlobChange
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob")] Stream blobStream,
        ILogger logger)
    {
        using var blobStreamReader = new StreamReader(blobStream);
        logger.LogInformation("Blob sample-container/sample-blob has been updated with content: {content}", blobStreamReader.ReadToEnd());
    }
}

事件方格策略

public static class BlobFunction_ReactToBlobChange_EventGrid
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob", Source = BlobTriggerSource.EventGrid)] Stream blobStream,
        ILogger logger)
    {
        using var blobStreamReader = new StreamReader(blobStream);
        logger.LogInformation("Blob sample-container/sample-blob has been updated with content: {content}", blobStreamReader.ReadToEnd());
    }
}

從資料流程讀取

public static class BlobFunction_ReadStream
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob-1")] Stream blobStream1,
        [Blob("sample-container/sample-blob-2", FileAccess.Read)] Stream blobStream2,
        ILogger logger)
    {
        using var blobStreamReader1 = new StreamReader(blobStream1);
        logger.LogInformation("Blob sample-container/sample-blob-1 has been updated with content: {content}", blobStreamReader1.ReadToEnd());
        using var blobStreamReader2 = new StreamReader(blobStream2);
        logger.LogInformation("Blob sample-container/sample-blob-2 has content: {content}", blobStreamReader2.ReadToEnd());
    }
}

寫入資料流程

public static class BlobFunction_WriteStream
{
    [FunctionName("BlobFunction")]
    public static async Task Run(
        [BlobTrigger("sample-container/sample-blob-1")] Stream blobStream1,
        [Blob("sample-container/sample-blob-2", FileAccess.Write)] Stream blobStream2,
        ILogger logger)
    {
        await blobStream1.CopyToAsync(blobStream2);
        logger.LogInformation("Blob sample-container/sample-blob-1 has been copied to sample-container/sample-blob-2");
    }
}

系結至字串

public static class BlobFunction_String
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob-1")] string blobContent1,
        [Blob("sample-container/sample-blob-2")] string blobContent2,
        ILogger logger)
    {
        logger.LogInformation("Blob sample-container/sample-blob-1 has been updated with content: {content}", blobContent1);
        logger.LogInformation("Blob sample-container/sample-blob-2 has content: {content}", blobContent2);
    }
}

將字串寫入 Blob

public static class BlobFunction_String_Write
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob-1")] string blobContent1,
        [Blob("sample-container/sample-blob-2")] out string blobContent2,
        ILogger logger)
    {
        logger.LogInformation("Blob sample-container/sample-blob-1 has been updated with content: {content}", blobContent1);
        blobContent2 = blobContent1;
        logger.LogInformation("Blob sample-container/sample-blob-1 has been copied to sample-container/sample-blob-2");
    }
}

系結至位元組陣列

public static class BlobFunction_ByteArray
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob-1")] byte[] blobContent1,
        [Blob("sample-container/sample-blob-2")] byte[] blobContent2,
        ILogger logger)
    {
        logger.LogInformation("Blob sample-container/sample-blob-1 has been updated with content: {content}", Encoding.UTF8.GetString(blobContent1));
        logger.LogInformation("Blob sample-container/sample-blob-2 has content: {content}", Encoding.UTF8.GetString(blobContent2));
    }
}

將位元組陣列寫入 Blob

public static class BlobFunction_ByteArray_Write
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob-1")] byte[] blobContent1,
        [Blob("sample-container/sample-blob-2")] out byte[] blobContent2,
        ILogger logger)
    {
        logger.LogInformation("Blob sample-container/sample-blob-1 has been updated with content: {content}", Encoding.UTF8.GetString(blobContent1));
        blobContent2 = blobContent1;
        logger.LogInformation("Blob sample-container/sample-blob-1 has been copied to sample-container/sample-blob-2");
    }
}

系結至 TextReader 和 TextWriter

public static class BlobFunction_TextReader_TextWriter
{
    [FunctionName("BlobFunction")]
    public static async Task Run(
        [BlobTrigger("sample-container/sample-blob-1")] TextReader blobContentReader1,
        [Blob("sample-container/sample-blob-2")] TextWriter blobContentWriter2,
        ILogger logger)
    {
        while (blobContentReader1.Peek() >= 0)
        {
            await blobContentWriter2.WriteLineAsync(await blobContentReader1.ReadLineAsync());
        }
        logger.LogInformation("Blob sample-container/sample-blob-1 has been copied to sample-container/sample-blob-2");
    }
}

系結至 Azure 儲存體 Blob SDK 類型

public static class BlobFunction_BlobClient
{
    [FunctionName("BlobFunction")]
    public static async Task Run(
        [BlobTrigger("sample-container/sample-blob-1")] BlobClient blobClient1,
        [Blob("sample-container/sample-blob-2")] BlobClient blobClient2,
        ILogger logger)
    {
        BlobProperties blobProperties1 = await blobClient1.GetPropertiesAsync();
        logger.LogInformation("Blob sample-container/sample-blob-1 has been updated on: {datetime}", blobProperties1.LastModified);
        BlobProperties blobProperties2 = await blobClient2.GetPropertiesAsync();
        logger.LogInformation("Blob sample-container/sample-blob-2 has been updated on: {datetime}", blobProperties2.LastModified);
    }
}

存取 Blob 容器

public static class BlobFunction_AccessContainer
{
    [FunctionName("BlobFunction")]
    public static async Task Run(
        [BlobTrigger("sample-container/sample-blob")] Stream blobStream,
        [Blob("sample-container")] BlobContainerClient blobContainerClient,
        ILogger logger)
    {
        logger.LogInformation("Blobs within container:");
        await foreach (BlobItem blobItem in blobContainerClient.GetBlobsAsync())
        {
            logger.LogInformation(blobItem.Name);
        }
    }
}

列舉容器中的 Blob

public static class BlobFunction_EnumerateBlobs_Stream
{
    [FunctionName("BlobFunction")]
    public static async Task Run(
        [BlobTrigger("sample-container/sample-blob")] Stream blobStream,
        [Blob("sample-container")] IEnumerable<Stream> blobs,
        ILogger logger)
    {
        logger.LogInformation("Blobs contents within container:");
        foreach (Stream content in blobs)
        {
            using var blobStreamReader = new StreamReader(content);
            logger.LogInformation(await blobStreamReader.ReadToEndAsync());
        }
    }
}

public static class BlobFunction_EnumerateBlobs_BlobClient
{
    [FunctionName("BlobFunction")]
    public static void Run(
        [BlobTrigger("sample-container/sample-blob")] Stream blobStream,
        [Blob("sample-container")] IEnumerable<BlobClient> blobs,
        ILogger logger)
    {
        logger.LogInformation("Blobs within container:");
        foreach (BlobClient blob in blobs)
        {
            logger.LogInformation(blob.Name);
        }
    }
}

設定擴充功能

請參閱範例函式應用程式。

疑難排解

如需疑難排解指引，請參閱監視Azure Functions。

下一步

閱讀 Azure 函式簡介或建立 Azure 函式指南。

參與

如需建置、測試和參與此程式庫的詳細資訊，請參閱儲存體 CONTRIBUTING.md 。

此專案歡迎參與和提供建議。大部分的參與都要求您同意「參與者授權合約 (CLA)」，宣告您有權且確實授與我們使用投稿的權利。如需詳細資訊，請造訪 cla.microsoft.com。

此專案採用 Microsoft Open Source Code of Conduct (Microsoft 開放原始碼管理辦法)。如需詳細資訊，請參閱管理辦法常見問題集，如有任何其他問題或意見請連絡 opencode@microsoft.com。

曝光數

共用方式為

適用于 .NET 的 Azure WebJobs 儲存體 Blob 用戶端程式庫 - 5.1.1 版

開始使用

安裝套件

必要條件

驗證用戶端

重要概念

使用 Blob 觸發程式

接聽策略

預設策略

事件方格

使用 Blob 系結

範例

回應 Blob 變更

預設策略

事件方格策略

從資料流程讀取

寫入資料流程

系結至字串

將字串寫入 Blob

系結至位元組陣列

將位元組陣列寫入 Blob

系結至 TextReader 和 TextWriter

系結至 Azure 儲存體 Blob SDK 類型

存取 Blob 容器

列舉容器中的 Blob

設定擴充功能

疑難排解

下一步

參與

意見反應

其他資源