Клиентская библиотека blob-объектов хранилища веб-заданий Azure для .NET версии 5.1.1

Статья
04/03/2023

Это расширение предоставляет функциональные возможности для доступа к blob-объектам службы хранилища Azure в Функции Azure.

Начало работы

Установка пакета

Установите расширение blob-объектов хранилища с помощью NuGet:

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

Аутентификация клиента

Чтобы расширение пользовалось большими двоичными объектами, вам потребуется строка подключения, которую можно найти на портале Azure или с помощью приведенного ниже фрагмента кода Azure CLI .

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

Строку подключения можно указать с помощью параметра приложения AzureWebJobsStorage.

Основные понятия

Использование триггера BLOB-объекта

Триггер хранилища BLOB-объектов запускает функцию при обнаружении нового или обновленного большого двоичного объекта. Содержимое BLOB-объекта предоставляется в качестве входных данных функции.

Ознакомьтесь с руководством , чтобы узнать, как активировать функцию Azure при изменении большого двоичного объекта.

Стратегии прослушивания

Триггер BLOB-объектов предлагает несколько стратегий, когда речь идет о прослушивании создания и изменения BLOB-объектов. Стратегию можно настроить, Source указав свойство BlobTrigger объекта (см. примеры ниже).

Стратегия по умолчанию

По умолчанию триггер больших двоичных объектов использует опрос, который работает как гибрид между проверкой журнала аналитики службы хранилища Azure и периодическим выполнением проверок контейнеров. Большие двоичные объекты проверяются в группах по 10 000 за раз с токеном продолжения, используемым между интервалами.

Ведение журнала аналитики службы хранилища Azure не включено по умолчанию. Сведения о том, как включить его, см. в статье Ведение журнала аналитики службы хранилища Azure .

Эта стратегия не рекомендуется использовать для крупномасштабных приложений или сценариев, требующих низкой задержки.

Сетка событий

События хранилища BLOB-объектов можно использовать для прослушивания изменений. Для этой стратегии требуется дополнительная настройка.

Эта стратегия рекомендуется использовать для крупномасштабных приложений.

Использование привязки BLOB-объектов

Привязка входных данных позволяет считывать данные хранилища BLOB-объектов в качестве входных данных в службе "Функции Azure". Привязка выходных данных позволяет изменять и удалять данные хранилища BLOB-объектов в службе "Функции Azure".

Чтобы узнать об использовании этого расширения для доступа к 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);
    }
}

Запись строки в большой двоичный объект

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));
    }
}

Запись массива байтов в большой двоичный объект

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");
    }
}

Привязка к типам пакета SDK службы хранилища BLOB-объектов Azure

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);
        }
    }
}

Перечисление больших двоичных объектов в контейнере

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.

Дальнейшие действия

Ознакомьтесь с введением в Функцию Azure или руководством по созданию функции Azure.

Участие

Дополнительные сведения о создании, тестировании и участии в этой библиотеке см. в CONTRIBUTING.md хранилища.

На этом проекте приветствуются публикации и предложения. Для участия в большинстве процессов по разработке документации необходимо принять лицензионное соглашение участника (CLA), в котором указывается, что вы предоставляете нам права на использование ваших публикаций. Дополнительные сведения см. на странице cla.microsoft.com.

В рамках этого проекта действуют правила поведения в отношении продуктов с открытым исходным кодом Майкрософт. Дополнительные сведения см. в разделе часто задаваемых вопросов о правилах поведения или обратитесь к opencode@microsoft.com с любыми дополнительными вопросами или комментариями.

Просмотры

Клиентская библиотека blob-объектов хранилища веб-заданий Azure для .NET версии 5.1.1

Начало работы

Установка пакета

Предварительные требования

Аутентификация клиента

Основные понятия

Использование триггера BLOB-объекта

Стратегии прослушивания

Стратегия по умолчанию

Сетка событий

Использование привязки BLOB-объектов

Примеры

Реагирование на изменение BLOB-объекта

Стратегия по умолчанию

Стратегия Сетки событий

Чтение из потока

Запись в поток

Привязка к строке

Запись строки в большой двоичный объект

Привязка к массиву байтов

Запись массива байтов в большой двоичный объект

Привязка к TextReader и TextWriter

Привязка к типам пакета SDK службы хранилища BLOB-объектов Azure

Доступ к контейнеру BLOB-объектов

Перечисление больших двоичных объектов в контейнере

Настройка расширения

Устранение неполадок

Дальнейшие действия

Участие

Обратная связь

Обратная связь

Дополнительные ресурсы