Руководство: Как активировать Функции Azure в контейнерах Blob с помощью подписки на событие

Предыдущие версии триггера больших двоичных объектов Функции Azure опрашивали контейнер хранилища на наличие изменений. Более последние версии расширения хранилища BLOB-объектов (5.x+) вместо этого используют подписку на событие Сетки событий в контейнере. Эта подписка на события снижает задержку, мгновенно запуская вашу функцию при возникновении изменений в контейнере, на который оформлена подписка.

В этой статье показано, как создать функцию, которая запускается при возникновении событий, когда в контейнер добавляется BLOB-объект. Вы используете Visual Studio Code для локальной разработки и проверяете код перед развертыванием проекта в Azure.

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

• Расширение служба хранилища Azure для Visual Studio Code.

Создайте функцию с триггером BLOB

При создании триггерной функции для хранилища объектов Blob с помощью Visual Studio Code одновременно создается новый проект. Необходимо изменить функцию, чтобы использовать подписку на события в качестве источника, а не использовать обычный контейнер опроса.

1. В Visual Studio Code нажмите клавишу F1, чтобы открыть палитру команд, введите Функции Azure: Create Function...и выберите "Создать проект".

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

   Не выбирайте папку проекта, которая уже входит в рабочую область.

3. В ответ на запросы введите следующие сведения:

   Запрос	Действие
   Выбор языка	Выберите C#.
   Выберите среду выполнения .NET	Выберите .NET 8.0 Isolated LTS.
   Выбор шаблона для первой функции проекта	Выберите Хранилище BLOB-объектов Azure trigger (using Event Grid).
   Укажите имя функции	Введите EventGridBlobTrigger.
   Укажите пространство имен	Введите My.Functions.
   Select setting from "local.settings.json" (Выберите параметр из файла local.settings.json)	Выберите Create new local app setting.
   Выбор подписки	При необходимости выберите подписку.
   Выбрать учетную запись хранения	Используйте эмулятор Azurite для локального хранилища.
   Путь в учетной записи хранения, отслеживаемой триггером	Примите значение по умолчанию samples-workitems.
   Выбор способа открытия проекта	Выберите Open in current window.

   Запрос	Действие
   Выбор языка	Выберите Python.
   Выбор модели программирования Python	Выберите Model V2
   Выберите интерпретатор Python для создания виртуальной среды	Выберите предпочитаемый интерпретатор Python. Если параметр не отображается, введите полный путь к двоичному файлу Python.
   Выбор шаблона для первой функции проекта	Выберите Blob trigger. (Шаблон на основе событий еще недоступен.)
   Укажите имя функции	Введите EventGridBlobTrigger.
   Путь в учетной записи хранения, отслеживаемой триггером	Примите значение по умолчанию samples-workitems.
   Select setting from "local.settings.json" (Выберите параметр из файла local.settings.json)	Выберите Create new local app setting.
   Выбор подписки	При необходимости выберите подписку.
   Выбрать учетную запись хранения	Используйте эмулятор Azurite для локального хранилища.
   Выбор способа открытия проекта	Выберите Open in current window.

   Запрос	Действие
   Выбор языка	Выберите Java.
   Выберите версию Java	Выберите Java 11 или Java 8, версию Java, в которой выполняются функции в Azure, и вы проверили ее локально.
   Укажите идентификатор группы	Выберите com.function.
   Укажите идентификатор артефакта	Выберите EventGridBlobTrigger (или значение по умолчанию).
   Укажите версию	Выберите 1.0-SNAPSHOT.
   Укажите имя пакета	Выберите com.function.
   Укажите имя приложения	Примите созданное имя, начиная с EventGridBlobTrigger.
   Выберите средство сборки для проекта Java	Выберите Maven.
   Выбор способа открытия проекта	Выберите Open in current window.

   Для вас создается функция, активируемая по HTTP (HttpExample). Вы не будете использовать эту функцию и должны вместо этого создать новую функцию.

   Запрос	Действие
   Выбор язык для проекта приложения-функции	Выберите TypeScript.
   Выбор модели программирования TypeScript	Выберите Model V4.
   Выбор шаблона для первой функции проекта	Выберите Хранилище BLOB-объектов Azure trigger (using Event Grid).
   Укажите имя функции	Введите EventGridBlobTrigger.
   Select setting from "local.settings.json" (Выберите параметр из файла local.settings.json)	Выберите Create new local app setting.
   Выбор подписки	При необходимости выберите подписку.
   Выбрать учетную запись хранения	Используйте эмулятор Azurite для локального хранилища.
   Путь в учетной записи хранения, отслеживаемой триггером	Примите значение по умолчанию samples-workitems.
   Выбор способа открытия проекта	Выберите Open in current window.

   Запрос	Действие
   Выбор язык для проекта приложения-функции	Выберите JavaScript.
   Выбор модели программирования JavaScript	Выберите Model V4.
   Выбор шаблона для первой функции проекта	Выберите Хранилище BLOB-объектов Azure trigger (using Event Grid).
   Укажите имя функции	Введите eventGridBlobTrigger.
   Select setting from "local.settings.json" (Выберите параметр из файла local.settings.json)	Выберите Create new local app setting.
   Выбор подписки	При необходимости выберите подписку.
   Выбрать учетную запись хранения	Используйте эмулятор Azurite для локального хранилища.
   Путь в учетной записи хранения, отслеживаемой триггером	Примите значение по умолчанию samples-workitems.
   Выбор способа открытия проекта	Выберите Open in current window.

   Запрос	Действие
   Выбор язык для проекта приложения-функции	Выберите PowerShell.
   Выбор шаблона для первой функции проекта	Выберите Хранилище BLOB-объектов Azure trigger (using Event Grid).
   Укажите имя функции	Введите EventGridBlobTrigger.
   Select setting from "local.settings.json" (Выберите параметр из файла local.settings.json)	Выберите Create new local app setting.
   Выбор подписки	При необходимости выберите подписку.
   Выбрать учетную запись хранения	Используйте эмулятор Azurite для локального хранилища.
   Путь в учетной записи хранения, отслеживаемой триггером	Примите значение по умолчанию samples-workitems.
   Выбор способа открытия проекта	Выберите Open in current window.

Теперь у вас есть функция, которая может быть активирована событиями в контейнере хранилища BLOB-объектов.

[Function(nameof(EventGridBlobTriggerCSharp))]
public async Task Run([BlobTrigger("PathValue/{name}", Source = BlobTriggerSource.EventGrid, Connection = "ConnectionValue")] Stream stream, string name)
{
    using var blobStreamReader = new StreamReader(stream);
    var content = await blobStreamReader.ReadToEndAsync();
    _logger.LogInformation("C# Blob Trigger (using Event Grid) processed blob\n Name: {name} \n Data: {content}", name, content);
}

    @FunctionName("EventGridBlobTrigger")
    @StorageAccount("<STORAGE_ACCOUNT>")
    public void run(
        @BlobTrigger(name = "content", source = "EventGrid", path = "samples-workitems/{name}", dataType = "binary") byte[] content,
        @BindingName("name") String name,
        final ExecutionContext context
    ) {
        context.getLogger().info("Java Blob trigger function processed a blob. Name: " + name + "\n  Size: " + content.length + " Bytes");
    }

{
    "bindings": [
        {
            "name": "InputBlob",
            "type": "blobTrigger",
            "direction": "in",
            "path": "samples-workitems/{name}",
            "source": "EventGrid",
            "connection":""
        }
    ]
}

const { app } = require('@azure/functions');

app.storageBlob('storageBlobTrigger1', {
    path: 'samples-workitems/{name}',
    connection: 'MyStorageAccountAppSetting',
    source: 'EventGrid',
    handler: (blob, context) => {
        context.log(
            `Storage blob function processed blob "${context.triggerMetadata.name}" with size ${blob.length} bytes`
        );
    },
});

import { app, InvocationContext } from '@azure/functions';

export async function storageBlobTrigger1(blob: Buffer, context: InvocationContext): Promise<void> {
    context.log(
        `Storage blob function processed blob "${context.triggerMetadata.name}" with size ${blob.length} bytes`
    );
}

app.storageBlob('storageBlobTrigger1', {
    path: 'samples-workitems/{name}',
    connection: 'MyStorageAccountAppSetting',
    source: 'EventGrid',
    handler: storageBlobTrigger1,
});

Обновление расширения хранилища

Чтобы использовать триггер хранилища BLOB-объектов на основе сетки событий, вам потребуется версия 5.x или более поздняя версия расширения хранилища функций Azure.

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

Подготовка эмуляции локального хранилища

Visual Studio Code использует Azurite для эмуляции служб хранилища Azure при локальном запуске. Используйте Azurite для эмуляции службы хранилища BLOB-объектов Azure во время локальной разработки и тестирования.

1. Если вы еще этого не сделали, установите расширение Azurite версии 3 для Visual Studio Code.

2. Убедитесь, что в файле local.settings.json задано значение для "UseDevelopmentStorage=true". Этот параметр указывает Core Tools использовать Azurite вместо подключения к реальной учетной записи хранения при локальном запуске.

3. Нажмите клавишу F1, чтобы открыть палитру команд, введите Azurite: Startи нажмите клавишу ВВОД. Это действие запускает эмулятор службы хранилища BLOB-объектов Azurite.

4. Выберите значок Azure на панели действий, разверните Рабочая область>Подключенные учетные записи хранения>Локальный эмулятор, щелкните правой кнопкой мыши контейнеры BLOB-объектов, выберите Создать контейнер BLOB..., введите имя samples-workitems и нажмите Enter.

   

5. Разверните Контейнеры BLOB-объектов>samples-workitems и выберите Загрузить файлы....

   

6. Выберите файл для отправки в локально эмулированный контейнер. Функция обрабатывает этот файл позже, чтобы проверить и отладить код функции. Текстовый файл может работать лучше всего с кодом шаблона триггера BLOB-объектов.

Локальное выполнение функции

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

1. Задайте все точки останова и нажмите клавишу F5, чтобы запустить проект для локальной отладки. Функции Azure Core Tools должны быть запущены в окне терминала.

2. Вернувшись в область Azure, разверните Workspace>Local Project>Functions, щелкните правой кнопкой мыши функцию и выберите Execute Function Now....

   

3. В диалоговом окне тела запроса введите samples-workitems/<TEST_FILE_NAME>, заменив <TEST_FILE_NAME> именем файла, который вы загрузили в локальный эмулятор хранилища.

4. Нажмите клавишу Enter, чтобы запустить функцию. Указанное вами значение — это путь к BLOB-объекту в локальном эмуляторе. Эта строка передаётся вашему триггеру в полезной нагрузке запроса, которая имитирует полезную нагрузку при вызове вашей функции подпиской на событие, чтобы сообщить о добавлении BLOB-объекта в контейнер.

5. Просмотрите выходные данные выполнения этой функции. Вы увидите в выходных данных имя файла и его содержимое. Если вы установили точки останова, вам может потребоваться продолжить выполнение.

Теперь, когда вы успешно проверили код функции локально, пора опубликовать проект в новом приложении-функции в Azure.

Подготовьте учетную запись службы хранилища Azure

Для подписок на события для службы хранилища Azure требуется учетная запись хранения общего назначения версии v2. Вы можете использовать расширение служба хранилища Azure для Visual Studio Code, чтобы создать эту учетную запись хранения.

1. В Visual Studio Code нажмите клавишу F1, чтобы открыть палитру команд и ввести служба хранилища Azure: Create Storage Account.... Укажите эти сведения при появлении запроса:

   Запрос	Действие
   Введите имя новой учетной записи хранения	Присвойте ему произвольное глобально уникальное имя. Имена учетных записей хранилища должны содержать от 3 до 24 символов и состоять только из строчных букв и цифр. Чтобы упростить идентификацию, используйте то же имя для группы ресурсов и имени приложения-функции.
   Выбор расположения для новых ресурсов	Для повышения производительности выберите регион рядом с вами.

   Расширение создает учетную запись хранения общего назначения версии 2 с указанным именем. То же имя также используется для группы ресурсов, содержащей учетную запись хранения. Триггер хранилища BLOB-объектов на основе Event Grid требует учетную запись хранения общего назначения версии v2.

2. Снова нажмите клавишу F1 и в палитре команд введите служба хранилища Azure: Create Blob Container.... Укажите эти сведения при появлении запроса:

   Запрос	Действие
   Выбор ресурса	Выберите созданную учетную запись хранения общего назначения версии 2.
   Введите имя нового контейнера BLOB-объектов	Введите samples-workitemsимя контейнера, на которое ссылается проект кода.

Для работы приложения-функции также требуется учетная запись хранения данных. Для простоты в этом руководстве используется та же учетная запись хранения для триггера BLOB-объекта и приложения-функции. Однако в рабочей среде может потребоваться отдельная учетная запись хранения для вашего приложения-функции. Дополнительные сведения см. в статье Рекомендации по хранению для Функций Azure.

Создайте приложение-функцию

Используйте эти шаги, чтобы создать приложение-функцию в плане Flex Consumption. При размещении приложения в плане Flex Consumption, триггеры Azure Хранилище BLOB-объектов должны использовать подписки на события.

1. В палитре команд введите Функции Azure: создайте приложение-функцию в Azure... (Дополнительно).

2. Следуйте инструкциям и предоставьте следующие сведения:

   Запрос	Выбор
   Введите глобально уникальное имя нового приложения-функции	Введите глобально уникальное имя, которое будет идентифицировать ваше новое приложение-функцию, а затем нажмите Enter. Допустимые символы для имени приложения-функции: a-z, 0-9 и -.
   Выбор плана размещения	Выберите Flex Consumption, который является рекомендуемым планом размещения для бессерверного размещения.
   Выбор расположения для новых ресурсов	Выберите расположение в регионе рядом с вами или рядом с другими службами, к которым обращаются ваши функции.
   Выберите стек сред выполнения	Выберите языковую версию, выполняемую локально.
   Выбор размера экземпляра	Выберите 512. Вы всегда можете изменить параметр размера экземпляра на более крупный размер позже.
   Введите максимальное число экземпляров	Выберите значение по умолчанию 100, которое ограничивает общий масштаб приложения. Можно также выбрать другое значение от 1 до 1000.
   Выбор группы ресурсов	Выберите "Создать группу ресурсов " и примите значение по умолчанию или введите другое имя новой группы, уникальной в подписке.
   Выбор типа проверки подлинности ресурса	Выберите управляемое удостоверение , чтобы приложение подключилось к удаленным ресурсам с помощью проверки подлинности идентификатора Microsoft Entra, а не с использованием общих секретов (строк подключения и ключей), которые являются менее безопасными.
   Выбор идентичности, назначенной пользователем	Выберите Создать новую пользовательскую назначенную идентичность.
   Выбор расположения для новых ресурсов	Выберите тот же регион, что и созданная учетная запись хранения. Если по какой-то причине этот регион не поддерживается моделью потребления Flex, он не отображается. В этом случае выберите ближайший регион . Дополнительные сведения см. в разделе "Просмотр поддерживаемых в настоящее время регионов".
   Выбрать учетную запись хранения	Выберите имя созданной учетной записи хранения.
   Выбор ресурса Application Insights для приложения	Выберите Создать новый ресурс Application Insights и в появившемся запросе укажите имя экземпляра, используемого для хранения данных среды выполнения ваших функций.

   Уведомление отображается после того, как приложение-функция будет создано. Выберите "Просмотреть выходные данные " в этом уведомлении, чтобы просмотреть результаты создания, включая созданные ресурсы Azure.

Развертывание кода функции

1. В палитре команд введите, а затем выберите Функции Azure: Развернуть в приложении-функции.

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

3. После завершения развертывания выберите "Просмотреть выходные данные ", чтобы просмотреть результаты создания и развертывания, включая созданные ресурсы Azure. Если вы пропустили уведомление, выберите значок колокольчика в правом нижнем углу, чтобы увидеть его снова.

   

Обновление параметров приложения

Так как процесс публикации не автоматически передает необходимые параметры приложения из local.settings.json файла, их необходимо передать в приложение-функцию, чтобы функция выполнялось правильно в Azure.

1. В палитре команд введите Функции Azure: Download Remote Settings..., и в Выбор ресурса выберите имя вашего приложения-функции.

2. Когда появится сообщение о том, что параметр AzureWebJobsStorage уже существует, выберите Да, чтобы перезаписать значение параметра локального эмулятора на фактическую строку подключения к учетной записи хранения из Azure.

3. В файле local.settings.json замените параметр локального эмулятора на ту же строку подключения, которая используется для AzureWebJobsStorage.

4. Удалите элемент FUNCTIONS_WORKER_RUNTIME, который не поддерживается в тарифном плане Flex Consumption.

5. В палитре команд введите Функции Azure: Upload Local Settings..., и в Выбор ресурса выберите имя вашего приложения-функции.

Теперь узел функций и триггер используют одну и ту же учетную запись хранения.

Создание URL-адреса конечной точки

Чтобы создать подписку на события, необходимо предоставить Event Grid URL-адрес конкретной конечной точки для отправки уведомлений о событиях Хранилище BLOB-объектов. Этот URL-адрес расширения blob состоит из следующих частей:

Хотя ваше приложение подключается к учетной записи хранения с помощью аутентификации через Microsoft Entra ID, ключ доступа к расширению BLOB помогает защитить вебхук расширения BLOB от несанкционированного доступа. Чтобы найти ключ доступа к расширению BLOB, выполните приведённые действия.

1. В Visual Studio Code выберите значок Azure на панели действий. В разделе Ресурсы разверните подписку, разверните Приложение-функция, щелкните правой кнопкой мыши созданное приложение-функцию и выберите Открыть на портале.

2. В меню слева в разделе Функции выберите Ключи приложения.

3. В разделе "Системные ключи" выберите ключ с именем blobs_extension и скопируйте значение ключа.

   Включите это значение в строку запроса нового URL-адреса конечной точки.

4. Создайте новый URL-адрес конечной точки для триггера BLOB-хранилища на основе следующего примера:

   https://<FUNCTION_APP_NAME>.azurewebsites.net/runtime/webhooks/blobs?functionName=Host.Functions.EventGridBlobTrigger&code=<BLOB_EXTENSION_KEY>
   

   В этом примере замените <FUNCTION_APP_NAME> именем приложения-функции и <BLOB_EXTENSION_KEY> значением, полученным на портале. Если для функции использовалось другое имя, замените EventGridBlobTrigger его именем.

Теперь этот URL-адрес конечной точки можно использовать для создания подписки на события.

Создание подписки на события

Подписка на события, работающая на базе Сетка событий Azure, создает события при изменениях в контейнере BLOB-объектов, на который оформлена подписка. Затем это событие отправляется в конечную точку расширения BLOB для вашей функции. После создания подписки на событие невозможно обновить URL-адрес конечной точки.

1. В Visual Studio Code щелкните значок Azure на панели действий. В разделе Ресурсы разверните подписку, разверните Учетные записи хранения, щелкните правой кнопкой мыши созданную ранее учетную запись хранения и выберите Открыть на портале.

2. Войдите в портал Azure и запишите название группы ресурсов для своей учетной записи хранения. Создайте другие ресурсы в той же группе, чтобы упростить очистку ресурсов при завершении.

3. Выберите параметр "События" в меню слева.

   

4. В окне События нажмите кнопку + Подписка на события и укажите значения из приведенной ниже таблицы на вкладке Базовые.

   Настройка	Предлагаемое значение	Описание:
   Имя	myBlobEventSub	Имя, идентифицирующее подписку на события. Используйте имя, чтобы быстро найти подписку на событие.
   Схема событий	Схема сетки событий	Используйте схему по умолчанию для событий.
   Имя системного раздела	samples-workitems-blobs	Имя раздела, представляющего контейнер. Этот раздел создается с первой подпиской и используется для будущих подписок на события.
   Фильтрация по типам событий	Blob created (Большой двоичный объект создан)
   Тип конечной точки	Вебхук	Триггер хранилища BLOB-объектов использует конечную точку веб-перехватчика.
   Конечная точка	URL-адрес конечной точки на базе Azure	Используйте URL-адрес конечной точки, который вы создали и который содержит значение ключа.

5. Выберите Подтвердить выбор, чтобы проверить URL-адрес конечной точки.

6. Перейдите на вкладку "Фильтры" и укажите следующие сведения в запросах:

   Настройка	Предлагаемое значение	Описание:
   Включение фильтрации субъектов	Включено	Позволяет фильтровать, какие BLOB-объекты могут активировать функцию.
   Тема начинается с	/blobServices/default/containers/<CONTAINER_NAME>/blobs/<BLOB_PREFIX>	Замените <CONTAINER_NAME и <BLOB_PREFIX> выбранными вами значениями. Этот параметр активирует подписку только для блобов, которые начинаются с BLOB_PREFIX и находятся в контейнере CONTAINER_NAME.
   Тема заканчивается с	.txt	Гарантирует, что функция запускается только для BLOB, заканчивающихся на .txt.

   Дополнительные сведения о фильтрации по определенным BLOB-объектам см. в разделе Фильтрация событий для Центры событий Azure.

7. Выберите Создать, чтобы создать подписку на события.

Отправка файла в контейнер

Вы можете загрузить файл с вашего компьютера в контейнер блоб-объектов с помощью Visual Studio Code.

1. В Visual Studio Code нажмите F1, чтобы открыть палитру команд, и введите служба хранилища Azure: Upload Files....

2. В диалоговом окне "Открыть" выберите файл, предпочтительный текстовый файл и нажмите кнопку "Отправить".

3. Введите следующую информацию в ответ на запросы:

   Настройка	Предлагаемое значение	Описание:
   Введите целевой каталог этой отправки	default	Примите значение /по умолчанию, которое является корнем контейнера.
   Выбор ресурса	Название учетной записи хранилища	Выберите имя учетной записи хранения, созданной на предыдущем шаге.
   Выберите тип ресурсов	Контейнеры BLOB-объектов	Вы загружаете данные в контейнер BLOB-объектов.
   Выберите контейнер BLOB	samples-workitems	Это значение представляет собой имя контейнера, созданного на предыдущем шаге.

Перейдите к локальной файловой системе, чтобы найти файл для отправки, а затем нажмите кнопку "Отправить ", чтобы отправить файл.

Проверка функции в Azure

При отправке файла в контейнер samples-workitems активируется функция. Чтобы проверить эту функцию, проверьте следующие элементы на портале Azure:

1. В учетной записи хранения перейдите на страницу "События", выберите "Подписки на события" и убедитесь, что событие доставлено. Отображение события на диаграмме может задержаться до пяти минут.

2. Вернувшись на страницу приложения-функции на портале, в разделе Functions найдите свою функцию и выберите Вызовы и другое. Вы должны увидеть трассировки, записанные в ходе успешного выполнения функции.

Очистка ресурсов

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

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

1. В Visual Studio Code нажмите клавишу F1, чтобы открыть палитру команд. В палитре команд найдите и щелкните Azure: Open in portal.

2. Выберите приложение-функцию и нажмите клавишу Enter. Страница приложения-функции откроется на портале Azure.

3. На вкладке Обзор выберите именованную ссылку рядом с полем Группа ресурсов.

   

4. На странице Группа ресурсов просмотрите список включенных ресурсов и убедитесь, что именно их нужно удалить.

5. Выберите Удалить группу ресурсов и следуйте инструкциям.

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

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

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

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