Краткое руководство. Создание приложения Устойчивые функции Python
Используйте Устойчивые функции, функцию Функции Azure для записи функций с отслеживанием состояния в бессерверной среде. Чтобы установить Устойчивые функции, установите расширение Функции Azure в Visual Studio Code. Расширение управляет состоянием, контрольными точками и перезапускается в приложении.
В этом кратком руководстве вы используете расширение Устойчивые функции в Visual Studio Code для локального создания и тестирования приложения hello world Устойчивые функции в Функции Azure. Устойчивые функции оркестрации и цепочки приложений объединяют вызовы к другим функциям. Затем вы публикуете код функции в Azure. Используемые средства доступны через расширение Visual Studio Code.
Необходимые компоненты
Для работы с этим кратким руководством вам понадобится:
Установленный экземпляр Visual Studio Code.
Установленное Функции Azure расширение Visual Studio Code.
Последняя версия установленных Функции Azure Core Tools.
Средство тестирования HTTP, которое обеспечивает безопасность данных. Дополнительные сведения см. в средствах тестирования HTTP.
Подписка Azure. Чтобы использовать Устойчивые функции, у вас должна быть учетная запись служба хранилища Azure.
Установлен Python версии 3.7, 3.8, 3.9 или 3.10.
Если у вас еще нет подписки Azure, создайте бесплатную учетную запись Azure, прежде чем начинать работу.
Создание локального проекта
В этом разделе вы используете Visual Studio Code. чтобы создать локальный проект Функций Azure.
В Visual Studio Code выберите F1 (или нажмите клавиши CTRL/CMD+SHIFT+P), чтобы открыть палитру команд. В командной строке (
>
), введите и выберите Функции Azure: Создать проект.Выберите Обзор. В диалоговом окне "Выбор папки" перейдите в папку, используемую для проекта, и нажмите кнопку "Выбрать".
В запросах укажите следующие сведения:
Prompt Действие Description Выбор языка для проекта приложения-функции Выберите Python. Создает локальный проект функций Python. Выбор версии Выберите Функции Azure версии 4. Этот параметр отображается только в том случае, если основные инструменты еще не установлены. В этом случае основные средства устанавливаются при первом запуске приложения. Версия Python Выберите Python 3.7, Python 3.8, Python 3.9 или Python 3.10. Visual Studio Code создает виртуальную среду с помощью выбранной версии. Выбор шаблона для первой функции проекта выберите Пока пропустить. Выбор способа открытия проекта Выберите "Открыть" в текущем окне. Открывает Visual Studio Code в выбранной папке.
В запросах укажите следующие сведения:
Prompt значение Описание Выбор языка Выберите Python (модель программирования версии 2). Создает локальный проект функций Python с помощью модели программирования версии 2. Выбор версии Выберите Функции Azure версии 4. Этот параметр отображается только в том случае, если основные инструменты еще не установлены. В этом случае основные средства устанавливаются при первом запуске приложения. Версия Python Выберите Python 3.7, Python 3.8, Python 3.9 или Python 3.10. Visual Studio Code создает виртуальную среду с помощью выбранной версии. Выбор способа открытия проекта Выберите "Открыть" в текущем окне. Открывает Visual Studio Code в выбранной папке.
Visual Studio Code устанавливает Функции Azure Core Tools, если требуется создать проект. Кроме того, создается проект приложения-функции в папке. Проект будет содержать файлы конфигурации host.json и local.settings.json.
В корневой папке также будет создан файл requirements.txt. Там будут указаны пакеты Python, необходимые для запуска приложения-функции.
Установка azure-functions-durable из PyPI
При создании проекта расширение Функции Azure Visual Studio Code автоматически создает виртуальную среду с выбранной версией Python. Вам нужно активировать виртуальную среду в терминале и установить ряд зависимостей, которые требуются для Функций Azure и Устойчивых функций.
Откройте файл requirements.txt в редакторе и измените его содержимое на следующее:
azure-functions azure-functions-durable
В текущей папке откройте интегрированный терминал редактора (CTRL+SHIFT+' ).
В интегрированном терминале активируйте виртуальную среду в текущей папке в зависимости от операционной системы.
Затем в интегрированном терминале, где активируется виртуальная среда, используйте pip для установки определенных пакетов.
python -m pip install -r requirements.txt
Создание функций
Самый простой Устойчивые функции приложение имеет три функции:
- Функция Orchestrator: рабочий процесс, который оркеструет другие функции.
- Функция действия: функция, вызываемая функцией оркестратора, выполняет работу и при необходимости возвращает значение.
- Клиентская функция: обычная функция в Azure, которая запускает функцию оркестратора. В этом примере используется функция, активироваемая HTTP.
Функция оркестратора
Шаблон используется для создания кода приложения Устойчивые функции в проекте.
В палитре команд введите и выберите Функции Azure: Создать функцию.
В запросах укажите следующие сведения:
Prompt Действие Description Выбор шаблона для функции Выберите оркестратор Устойчивые функции. Создает оркестрацию приложений Устойчивые функции. Укажите имя функции Выберите HelloOrchestrator. Имя устойчивой функции.
Вы добавили оркестратор для координации функций действий. Откройте файл HelloOrchestrator/__init__.py и изучите функцию оркестратора. Каждый вызов context.call_activity
приводит к вызову функции действия с именем Hello
.
Затем добавьте указанную Hello
функцию действия.
Функция действия
В палитре команд введите и выберите Функции Azure: Создать функцию.
В запросах укажите следующие сведения:
Prompt Действие Description Выбор шаблона для функции Выберите действие Устойчивые функции. Создает функцию действия. Укажите имя функции Введите Hello. Имя функции действия.
Вы добавили Hello
функцию действия, вызываемую оркестратором. Откройте файл Hello/__init__.py и убедитесь, что эта функция принимает имя в качестве входных данных и возвращает приветствие. Функция действия — это выполнение таких действий, как вызов базы данных или выполнение вычисления.
Наконец, вы добавите функцию, активированную HTTP, которая запускает оркестрацию.
Функция клиента (начальный объект HTTP)
В палитре команд введите и выберите Функции Azure: Создать функцию.
В запросах укажите следующие сведения:
Prompt Действие Description Выбор шаблона для функции Выберите начальный Устойчивые функции HTTP. Создает начальную функцию HTTP. Укажите имя функции Введите DurableFunctionsHttpStart. Имя клиентской функции Уровень авторизации Выберите "Анонимный". Для демонстрационных целей это значение позволяет вызывать функцию без использования проверки подлинности.
Вы добавили функцию, активированную HTTP, которая запускает оркестрацию. Откройте файл DurableFunctionsHttpStart/__init__.py и убедитесь, что эта функция client.start_new
запускает новую оркестрацию с помощью. После этого она должна вызывать client.create_check_status_response
, чтобы вернуть ответ HTTP с URL-адресами, которые позволяют отслеживать новую оркестрацию и управлять ею.
Теперь у вас есть готовое приложение Устойчивых функций, которое можно выполнить локально и развернуть в Azure.
Требования
Для модели программирования Python версии 2 требуются следующие минимальные версии:
- среда выполнения Функции Azure версии 4.16+
- Функции Azure Core Tools версии 4.0.5095+ (при локальном запуске)
- azure-functions-durable v1.2.4+
Включение модели программирования версии 2
Для запуска модели программирования версии 2 требуется следующий параметр приложения:
- Имя:
AzureWebJobsFeatureFlags
- Значение:
EnableWorkerIndexing
Если вы работаете локально с помощью Функции Azure Core Tools, добавьте этот параметр в файл local.settings.json. Если вы работаете в Azure, выполните следующие действия с помощью соответствующего средства:
Замените и <RESOURCE_GROUP_NAME>
назовите <FUNCTION_APP_NAME>
приложение-функцию и группу ресурсов соответственно.
az functionapp config appsettings set --name <FUNCTION_APP_NAME> --resource-group <RESOURCE_GROUP_NAME> --settings AzureWebJobsFeatureFlags=EnableWorkerIndexing
Чтобы создать базовое приложение Устойчивые функции с помощью этих трех типов функций, замените содержимое function_app.py следующим кодом Python:
import azure.functions as func
import azure.durable_functions as df
myApp = df.DFApp(http_auth_level=func.AuthLevel.ANONYMOUS)
# An HTTP-triggered function with a Durable Functions client binding
@myApp.route(route="orchestrators/{functionName}")
@myApp.durable_client_input(client_name="client")
async def http_start(req: func.HttpRequest, client):
function_name = req.route_params.get('functionName')
instance_id = await client.start_new(function_name)
response = client.create_check_status_response(req, instance_id)
return response
# Orchestrator
@myApp.orchestration_trigger(context_name="context")
def hello_orchestrator(context):
result1 = yield context.call_activity("hello", "Seattle")
result2 = yield context.call_activity("hello", "Tokyo")
result3 = yield context.call_activity("hello", "London")
return [result1, result2, result3]
# Activity
@myApp.activity_trigger(input_name="city")
def hello(city: str):
return f"Hello {city}"
Ознакомьтесь со следующей таблицей, чтобы объяснить каждую функцию и ее назначение в примере:
Метод | Description |
---|---|
hello_orchestrator |
Функция оркестратора, описывающая рабочий процесс. В этом случае оркестрация запускается, вызывает три функции в последовательности, а затем возвращает упорядоченные результаты всех трех функций в списке. |
hello |
Функция действия, которая выполняет работу, оркестрированную. Функция возвращает простое приветствие городу, переданном в качестве аргумента. |
http_start |
Функция с триггером HTTP, которая запускает экземпляр оркестрации и возвращает check status ответ. |
Примечание.
Устойчивые функции также поддерживает схемы Python версии 2. Чтобы использовать схемы, зарегистрируйте функции схемы с помощью устойчивого класса azure-functions Blueprint
. Вы можете зарегистрировать полученную схему как обычно. Пример можно использовать в качестве примера.
Локальное тестирование функции
Функции Azure Core Tools предоставляет возможность запуска проекта Функции Azure на локальном компьютере разработки. Если он не установлен, вам будет предложено установить эти средства при первом запуске функции в Visual Studio Code.
Чтобы проверить функцию, установите точку останова
Hello
в коде функции действия (в Hello/__init__.py). Выберите F5 или выберите "Отладка " в палитре команд, чтобы запустить проект приложения-функции. Выходные данные основных инструментов отображаются на панели терминала.
Чтобы проверить функцию, задайте точку останова в коде
hello
функции действия. Выберите F5 или выберите "Отладка " в палитре команд, чтобы запустить проект приложения-функции. Выходные данные основных инструментов отображаются на панели терминала.
Устойчивые функции требуется выполнить учетную запись хранения Azure. Когда Visual Studio Code предложит выбрать учетную запись хранения, щелкните Выбрать учетную запись хранения.
В запросах укажите следующие сведения, чтобы создать новую учетную запись хранения в Azure.
Prompt Действие Description Выбор подписки Выберите имя подписки. Вашу подписку Azure. Выбрать учетную запись хранения Выберите Создать новую учетную запись хранения. Введите имя новой учетной записи хранения Введите уникальное имя. Имя учетной записи хранения для создания. Выбор группы ресурсов Введите уникальное имя. Имя создаваемой группы ресурсов. Выбор расположения Выберите регион Azure. Выберите регион, близкий к вам. На панели терминала скопируйте конечную точку URL-адреса функции, активируемой HTTP.
Используйте браузер или средство тестирования HTTP для отправки HTTP-запроса POST в конечную точку URL-адреса.
Последний сегмент замените именем функции оркестратора (
HelloOrchestrator
в нашем примере). URL-адрес должен выглядеть приблизительно так:http://localhost:7071/api/orchestrators/HelloOrchestrator
.Ответ — это начальный результат функции HTTP. Он позволяет узнать, что устойчивый оркестрация успешно запущена. Он еще не отображает конечный результат оркестрации. Ответ включает несколько полезных URL-адреса. Теперь запросите состояние оркестрации.
Скопируйте значение
statusQueryGetUri
URL-адреса, вставьте его в адресную строку браузера и выполните запрос. Вы также можете продолжать использовать средство тестирования HTTP для выдачи запроса GET.Запрос запрашивает экземпляр оркестрации для состояния. Вы увидите, что экземпляр завершен и содержит выходные данные или результаты устойчивой функции. Похоже на этот пример:
{ "name": "HelloOrchestrator", "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a", "runtimeStatus": "Completed", "input": null, "customStatus": null, "output": [ "Hello Tokyo!", "Hello Seattle!", "Hello London!" ], "createdTime": "2020-03-18T21:54:49Z", "lastUpdatedTime": "2020-03-18T21:54:54Z" }
Используйте браузер или средство тестирования HTTP для отправки HTTP-запроса POST в конечную точку URL-адреса.
Последний сегмент замените именем функции оркестратора (
HelloOrchestrator
в нашем примере). URL-адрес должен выглядеть приблизительно так:http://localhost:7071/api/orchestrators/HelloOrchestrator
.Ответ — это начальный результат функции HTTP. Он позволяет узнать, что устойчивый оркестрация успешно запущена. Он еще не отображает конечный результат оркестрации. Ответ включает несколько полезных URL-адреса. Теперь запросите состояние оркестрации.
Скопируйте значение
statusQueryGetUri
URL-адреса, вставьте его в адресную строку браузера и выполните запрос. Вы также можете продолжать использовать средство тестирования HTTP для выдачи запроса GET.Запрос запрашивает экземпляр оркестрации для состояния. Вы увидите, что экземпляр завершен и содержит выходные данные или результаты устойчивой функции. Похоже на этот пример:
{ "name": "hello_orchestrator", "instanceId": "9a528a9e926f4b46b7d3deaa134b7e8a", "runtimeStatus": "Completed", "input": null, "customStatus": null, "output": [ "Hello Tokyo!", "Hello Seattle!", "Hello London!" ], "createdTime": "2020-03-18T21:54:49Z", "lastUpdatedTime": "2020-03-18T21:54:54Z" }
- Чтобы остановить отладку, в Visual Studio Code выберите SHIFT+F5.
После проверки правильности работы функции на локальном компьютере пришло время опубликовать проект в Azure.
Вход в Azure
Прежде чем создавать ресурсы Azure или публиковать приложение, необходимо войти в Azure.
Если вы еще не вошли, на панели действий выберите значок Azure. Затем в разделе "Ресурсы" выберите вход в Azure.
Если вы уже выполнили вход и видите существующие подписки, перейдите к следующему разделу. Если у вас еще нет учетной записи Azure, выберите "Создать учетную запись Azure". Учащиеся могут выбрать "Создать учетную запись Azure для учащихся".
При появлении запроса в браузере выберите свою учетную запись Azure и войдите с помощью учетных данных учетной записи Azure. Если вы создаете новую учетную запись, вы можете выполнить вход после ее создания.
После успешного входа можно закрыть новое окно браузера. Подписки, принадлежащие вашей учетной записи Azure, отображаются на боковой панели.
Создание приложения-функции в Azure
В этом разделе показано, как создать приложение-функцию и связанные ресурсы в подписке Azure. Многие решения по созданию ресурсов принимаются на основе поведения по умолчанию. Для получения большего контроля над созданными ресурсами необходимо создать приложение-функцию с дополнительными параметрами.
В Visual Studio Code нажмите клавишу F1, чтобы открыть палитру команд. В командной строке (
>
), введите и выберите Функции Azure: создание приложения-функции в Azure.В запросах укажите следующие сведения:
На панели "Журнал действий" расширение Azure отображает состояние отдельных ресурсов, созданных в Azure.
При создании приложения-функции в подписке Azure создаются следующие связанные ресурсы. Ресурсы именуются на основе имени, введенного для приложения-функции.
- группу ресурсов — логический контейнер связанных ресурсов;
- Учетная запись хранения Azure уровня "Стандартный" для сохранения состояния и других сведений о проектах.
- Приложение-функция, которое предоставляет окружение для выполнения кода вашей функции. Приложение-функция позволяет группировать функции в логические единицы и упростить развертывание, масштабирование и совместное использование ресурсов, а также управление ими в рамках единого плана размещения.
- План службы приложение Azure, определяющий базовый узел приложения-функции.
- Экземпляр Application Insights, подключенный к приложению-функции, и который отслеживает использование функций в приложении.
После создания приложения-функции и применения пакета развертывания отобразится уведомление.
Совет
По умолчанию ресурсы Azure, необходимые приложению-функции, создаются на основе имени, введенного для приложения-функции. По умолчанию ресурсы создаются с приложением-функцией в той же группе ресурсов. Если вы хотите настроить имена связанных ресурсов или повторно использовать существующие ресурсы, опубликуйте проект с дополнительными параметрами создания.
Развертывание проекта в Azure
Внимание
Развертывание в существующем приложении-функции всегда перезаписывает содержимое этого приложения в Azure.
В палитре команд введите и выберите Функции Azure: Развернуть в приложении-функции.
Выберите только что созданное приложение-функцию. При появлении запроса на перезапись предыдущих развертываний выберите "Развернуть ", чтобы развернуть код функции в новом ресурсе приложения-функции.
После завершения развертывания выберите "Просмотреть выходные данные ", чтобы просмотреть результаты создания и развертывания, включая созданные ресурсы Azure. Если вы пропустили уведомление, выберите значок колокольчика в правом нижнем углу, чтобы увидеть его снова.
Тестирование функции в Azure
Скопируйте URL-адрес триггера HTTP из выходной панели. URL-адрес, вызывающий функцию, активируемую HTTP, должен иметь следующий формат:
https://<functionappname>.azurewebsites.net/api/orchestrators/HelloOrchestrator
Скопируйте URL-адрес триггера HTTP из выходной панели. URL-адрес, вызывающий функцию, активируемую HTTP, должен иметь следующий формат:
https://<functionappname>.azurewebsites.net/api/orchestrators/hello_orchestrator
- Вставьте новый URL-адрес HTTP-запроса в адресную строку браузера. При использовании опубликованного приложения можно ожидать, что вы получите тот же ответ о состоянии, который вы получили при локальном тестировании.
Приложение Python Устойчивые функции, созданное и опубликованное с помощью Visual Studio Code, готово к использованию.
Очистка ресурсов
Если вам больше не нужны ресурсы, созданные для выполнения краткого руководства, чтобы избежать связанных затрат в подписке Azure, удалите группу ресурсов и все связанные ресурсы.
Связанный контент
- Узнайте о распространенных шаблонах приложений Устойчивые функции.