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

Статья
11/21/2023

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

Действие	Тип
Выполнение функции при внесении изменений в данные хранилища BLOB-объектов	Триггер
Чтение данных из хранилища BLOB-объектов в функции	Входная привязка
Разрешить функции записи данных хранилища BLOB-объектов	Выходная привязка

Установка расширения

Устанавливаемый пакет расширения NuGet зависит от режима C#, который используется в приложении-функции:

Изолированная рабочая модель
Модель внутрипроцессного процесса

Функции выполняются в изолированном рабочем процессе C#. Дополнительные сведения см. в руководстве по запуску Функции Azure C# в изолированном рабочем процессе.

Функциональные возможности расширения отличаются в зависимости от версии расширения:

В этом разделе описывается использование библиотеки классов. Для сценариев C# необходимо установить пакет расширений версии 4.x.

В этой версии появляется возможность подключения с использованием удостоверения, а не секрета. Руководство по настройке приложений-функций с помощью управляемых удостоверений см. в руководстве по созданию приложения-функции с подключениями на основе удостоверений.

Эта версия позволяет выполнить привязку к типам из Azure.Storage.Blobs. Дополнительные сведения об отличиях этих новых типов WindowsAzure.Storage и Microsoft.Azure.Storage способах их миграции в Руководстве по их миграции из Руководства по миграции Azure.Storage.Blobs.

Это расширение доступно путем установки пакета Microsoft.Azure.WebJobs.Extensions.Storage.Blobs NuGet версии 5.x.

С использованием .NET CLI:

dotnet add package Microsoft.Azure.WebJobs.Extensions.Storage.Blobs --version 5.0.0

Примечание.

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

Ранее расширения поставлялись вместе как Microsoft.Azure.WebJobs.Extensions.Storage, версия 4.x. Этот же пакет также имеет версию 5.x, которая ссылается на разделенные пакеты только для BLOB-объектов и очередей. Поэтому при обновлении ссылок на пакеты из более старых версий может потребоваться дополнительная ссылка на новый пакет NuGet Microsoft.Azure.WebJobs.Extensions.Tables. Кроме того, при ссылке на эти более новые разделенные пакеты убедитесь, что вы не ссылаетесь на более старую версию объединенного пакета хранилища, так как это приведет к конфликтам из-за двух определений одних и тех же привязок.

Добавьте расширение в проект, установив Microsoft.Azure.Functions.Worker.Extensions.служба хранилища. Пакет NuGet больших двоичных объектов версии 5.x или более поздней версии.

С использованием .NET CLI:

dotnet add package Microsoft.Azure.Functions.Worker.Extensions.Storage.Blobs

Примечание.

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

Ранее расширения, отправленные вместе как Microsoft.Azure.Functions.Worker.Extensions.служба хранилища версии 4.x. Этот же пакет также имеет версию 5.x, которая ссылается на разделенные пакеты только для BLOB-объектов и очередей. При обновлении ссылок на пакет из более старых версий может потребоваться дополнительно ссылаться на новый пакет NuGet Microsoft.Azure.Functions.Worker.Extensions.Tables . Кроме того, при ссылке на эти более новые разделенные пакеты убедитесь, что вы не ссылаетесь на более старую версию объединенного пакета хранилища, так как это приведет к конфликтам из-за двух определений одних и тех же привязок.

Если вы пишете приложение с помощью F#, необходимо также настроить это расширение в рамках конфигурации запуска приложения. В вызове ConfigureFunctionsWorkerDefaults() или ConfigureFunctionsWebApplication()добавьте делегат, принимающее IFunctionsWorkerApplication параметр. Затем в теле этого делегата вызовите ConfigureBlobStorageExtension() объект:

let hostBuilder = new HostBuilder()
hostBuilder.ConfigureFunctionsWorkerDefaults(fun (context: HostBuilderContext) (appBuilder: IFunctionsWorkerApplicationBuilder) ->
    appBuilder.ConfigureBlobStorageExtension() |> ignore
) |> ignore

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

Привязка хранилища BLOB-объектов входит в пакет расширений, который указан в файле проекта host.json. Возможно, потребуется изменить этот пакет, чтобы изменить версию привязки, а также в том случае если пакеты еще не установлены. Дополнительные сведения см. в разделе Пакет расширений.

Эту версию расширения можно добавить из пакета расширений версии 3, добавив или заменив следующий код в файле host.json:

{
    "version": "2.0",
    "extensionBundle": {
        "id": "Microsoft.Azure.Functions.ExtensionBundle",
        "version": "[3.3.0, 4.0.0)"
    }
}

Для получения дополнительных сведений см. раздел Обновление расширений.

Типы привязки

Типы привязки, поддерживаемые для .NET, зависят от версии расширения и режима выполнения C#, что может быть одним из следующих типов:

Изолированная рабочая модель
Модель внутрипроцессного процесса

Изолированная библиотека классов рабочих процессов, скомпилированная функция C# выполняется в процессе, изолированном от среды выполнения.

Выберите версию, чтобы просмотреть сведения о типе привязки для режима и версии.

Расширение BLOB-объектов Azure поддерживает типы параметров в соответствии с таблицей ниже.

Сценарий привязки	Типы параметров
Триггер BLOB-объектов	Поток `TextReader` `string` `byte[]` BinaryData BlobClient¹ BlockBlobClient¹ PageBlobClient¹ AppendBlobClient¹ BlobBaseClient¹
Входные данные BLOB-объектов (один большой двоичный объект)	Поток `TextReader` `string` `byte[]` BinaryData BlobClient¹ BlockBlobClient¹ PageBlobClient¹ AppendBlobClient¹ BlobBaseClient¹
Входные данные BLOB-объектов (несколько больших двоичных объектов из контейнера)	`IEnumerable<T>` где `T` является одним из типов входных привязок больших двоичных объектов
Выходные данные BLOB-объектов (один большой двоичный объект)	Поток `TextWriter` `string` `byte[]`
Выходные данные BLOB-объектов (несколько больших двоичных объектов)	`ICollector<T>` или `IAsyncCollector<T>` где `T` находится один из типов выходных привязок большого двоичного объекта

¹ Типы клиентов требуют Access , чтобы свойство атрибута было задано FileAccess.ReadWrite.

Примеры использования этих типов см. в разделе репозитория GitHub для расширения. Узнайте больше о типах из пакета SDK Azure, о том, как они отличаются от предыдущих версий и как перенести их из Azure.служба хранилища. Руководство по миграции больших двоичных объектов.

Более ранние версии расширения предоставляют типы из устаревшей версии Microsoft.Azure.служба хранилища. Пространство имен BLOB-объектов. Новые типы из Azure.служба хранилища. Большие двоичные объекты являются эксклюзивными для расширения 5.x и выше.

Эта версия расширения BLOB-объектов Azure поддерживает типы параметров в соответствии с таблицей ниже.

Привязка	Типы параметров
Триггер BLOB-объектов	Поток `TextReader` `string` `byte[]` ICloudBlob¹ CloudBlockBlob¹ CloudPageBlob¹ CloudAppendBlob¹
Входные данные BLOB-объектов	Поток `TextReader` `string` `byte[]` ICloudBlob¹ CloudBlockBlob¹ CloudPageBlob¹ CloudAppendBlob¹
Выходные данные BLOB-объектов	Поток `TextWriter` `string` `byte[]`

¹ Эти типы требуют Access , чтобы свойство атрибута было задано FileAccess.ReadWrite.

²IEnumerable<T> предоставляет перечисление больших двоичных объектов в контейнере. T Здесь можно использовать любой из других поддерживаемых типов.

Изолированный рабочий процесс поддерживает типы параметров в соответствии с таблицами ниже.

триггер большого двоичного объекта;

Триггер большого двоичного объекта может привязаться к следующим типам:

Тип	Описание
`string`	Содержимое большого двоичного объекта в виде строки. Используется, когда содержимое большого двоичного объекта является простым текстом.
`byte[]`	Байты содержимого большого двоичного объекта.
Сериализуемые в JSON типы	Если большой двоичный объект содержит данные JSON, функции пытаются десериализировать данные JSON в обычный тип объекта CLR (POCO).
Поток¹	Входной поток содержимого большого двоичного объекта.
BlobClient¹, BlockBlobClient¹, PageBlobClient¹, AppendBlobClient¹, BlobBaseClient¹	Клиент, подключенный к большому двоичному объекту. Этот набор типов обеспечивает большую часть управления обработкой большого двоичного объекта и может использоваться для записи обратно в большой двоичный объект, если подключение имеет достаточно разрешений.

¹ Для использования этих типов необходимо ссылаться на Microsoft.Azure.Functions.Worker.Extensions.служба хранилища. Большие двоичные объекты 6.0.0 или более поздней версии и распространенные зависимости для привязок типов ПАКЕТА SDK.

входная привязка большого двоичного объекта;

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

Тип	Описание
`string`	Содержимое большого двоичного объекта в виде строки. Используется, когда содержимое большого двоичного объекта является простым текстом.
`byte[]`	Байты содержимого большого двоичного объекта.
Сериализуемые в JSON типы	Если большой двоичный объект содержит данные JSON, функции пытаются десериализировать данные JSON в обычный тип объекта CLR (POCO).
Поток¹	Входной поток содержимого большого двоичного объекта.
BlobClient¹, BlockBlobClient¹, PageBlobClient¹, AppendBlobClient¹, BlobBaseClient¹	Клиент, подключенный к большому двоичному объекту. Этот набор типов предлагает большую часть управления для обработки БОЛЬШОго двоичного объекта и может использоваться для записи обратно в него, если подключение имеет достаточно разрешений.

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

Тип Описание

T[] или List<T> где T находится один из типов входных привязок большого двоичного объекта Массив или список нескольких больших двоичных объектов. Каждая запись представляет один большой двоичный объект из контейнера. Вы также можете привязаться к любым интерфейсам, реализованным этими типами, например IEnumerable<T>.

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

Тип	Описание
`T[]` или `List<T>` где `T` находится один из типов входных привязок большого двоичного объекта	Массив или список нескольких больших двоичных объектов. Каждая запись представляет один большой двоичный объект из контейнера. Вы также можете привязаться к любым интерфейсам, реализованным этими типами, например `IEnumerable<T>`.
BlobContainerClient¹	Клиент, подключенный к контейнеру. Этот тип предоставляет большую часть управления для обработки контейнера и может использоваться для записи в него, если подключение имеет достаточно разрешений.

выходная привязка большого двоичного объекта.

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

Тип	Описание
`string`	Содержимое большого двоичного объекта в виде строки. Используется, когда содержимое большого двоичного объекта является простым текстом.
`byte[]`	Байты содержимого большого двоичного объекта.
Сериализуемые в JSON типы	Объект, представляющий содержимое БОЛЬШОго двоичного объекта JSON. Функции пытаются сериализовать обычный тип объекта CLR (POCO) в данные JSON.

Если требуется, чтобы функция записывала в несколько больших двоичных объектов, выходная привязка большого двоичного объекта может привязаться к следующим типам:

Тип	Описание
`T[]` где `T` является одним из типов выходных привязок большого двоичного объекта	Массив, содержащий содержимое для нескольких больших двоичных объектов. Каждая запись представляет содержимое одного большого двоичного объекта.

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

Параметры файла host.json

В этом разделе описываются параметры конфигурации приложения-функции, доступные для функций, использующих эту привязку. Эти параметры применяются только при использовании расширения версии 5.0.0 и более поздних версий. В приведенном ниже примере файла host.json содержатся только параметры этой привязки для версии 2.x или новее. Дополнительные сведения о параметрах конфигурации приложения-функции в версии 2.x или более поздней см. в статье Справочник по файлу host.json для Функций Azure.

Примечание.

Этот раздел не применяется к версиям расширений до версии 5.0.0. Для этих более ранних версий нет параметров конфигурации приложения-функции для BLOB-объектов.

{
    "version": "2.0",
    "extensions": {
        "blobs": {
            "maxDegreeOfParallelism": 4,
            "poisonBlobThreshold": 1
        }
    }
}

Свойство	По умолчанию	Description
maxDegreeOfParallelism	8 * (количество доступных ядер)	Целочисленное число одновременных вызовов, разрешенное для всех функций, активированных большим двоичным объектом, в данном приложении-функции. Минимальное допустимое значение — 1.
poisonBlobThreshold	5	Целое число раз, чтобы попытаться обработать сообщение, прежде чем переместить его в очередь яда. Минимальное допустимое значение — 1.

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

Установка расширения

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

Типы привязки

Параметры файла host.json

Следующие шаги

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